获取物流选项 - 宠物商店

检索物流选项列表。

{ "shipping_options": [ { "id": "so_01G1G5V27GYX4QXNARRQCW1N8T", "name": "PostFake Standard", "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G", "region": {}, "profile_id": "sp_01G1G5V239ENSZ5MV4JAR737BM", "provider_id": "manual", "amount": 200, "is_return": false, "admin_only": false, "includes_tax": false, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "price_type": "flat_rate", "data": {}, "metadata": { "car": "white" }, "profile": { "id": "sp_01G1G5V239ENSZ5MV4JAR737BM", "name": "默认送货方案", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "type": "default", "products": [ {} ], "shipping_options": [ {} ], "metadata": { "car": "white" } }, "provider": { "id": "manual", "is_installed": true }, "requirements": [ { "id": "sor_01G1G5V29AB4CTNDRFSRWSRKWD", "shipping_option_id": "so_01G1G5V27GYX4QXNARRQCW1N8T", "shipping_option": {}, "amount": 100, "deleted_at": "2019-08-24T14:15:22Z", "type": "min_subtotal" } ], "price_incl_tax": 0, "tax_amount": 0, "tax_rates": [ { "rate": 0, "name": "string", "code": "string" } ] } ] }

请求参数

Query 参数

is_return

string

可选

Whether return shipping options should be included. By default, all shipping options are returned.

product_ids

string

可选

"Comma-separated list of Product IDs to filter Shipping Options by. If provided, only shipping options that can be used with the provided products are retrieved."

region_id

string

可选

"The ID of the region that the shipping options belong to. If not provided, all shipping options are retrieved."

返回响应

🟢200正常

application/json

Body

物流选项列表。

shipping_options

array[object (Priced Shipping Option) {22}]

必需

物流选项详细信息数组。

string

送货选项的 ID

必需

示例值:

so_01G1G5V27GYX4QXNARRQCW1N8T

name

string

必需

送货选项的名称 - 这可能会显示给客户。

示例值:

PostFake Standard

region_id

string

必需

此送货选项可在其中使用的地区的 ID。

示例值:

reg_01G1G5V26T9H8Y0M4JNE3YGA4G

region

object | null

可选

此送货选项可在其中使用的地区的详细信息。

profile_id

string

必需

送货选项所属的送货方案的 ID。

示例值:

sp_01G1G5V239ENSZ5MV4JAR737BM

provider_id

string

必需

稍后将用于处理从此送货选项及其配送创建的送货方式的配送提供程序的 ID。

示例值:

manual

amount

integer | null

必需

当送货选项价格类型为 flat_rate 时，运费的收费金额。

示例值:

200

is_return

boolean

必需

指示送货选项是否可用于退货发货的标志。

默认值:

false

admin_only

boolean

必需

指示送货选项的使用是否仅限于管理员用户的标志。

默认值:

false

includes_tax

boolean

可选

送货选项价格是否包含税费

默认值:

false

created_at

string <date-time>

必需

资源创建时间（含时区）。

updated_at

string <date-time>

必需

资源更新时间（含时区）。

deleted_at

string <date-time> | null

必需

资源删除时间（含时区）。

price_type

enum<string>

必需

从送货选项创建送货方式时使用的定价计算类型。可以是 flat_rate（固定价格）或 calculated（如果配送提供程序可以提供价格计算）。

枚举值:

flat_ratecalculated

示例值:

flat_rate

data

object

必需

配送提供程序识别送货选项所需的数据。

示例值:

{}

metadata

object | null

必需

包含其他详细信息的可选键值映射

示例值:

{"car":"white"}

profile

object

Shipping Profile

可选

A Shipping Profile has a set of defined Shipping Options that can be used to fulfill a given set of Products. For example, gift cards are shipped differently than physical products, so a shipping profile with the type gift_card groups together the shipping options that can only be used for gift cards.

provider

object

Fulfillment Provider

可选

配送提供程序表示安装在 Medusa 后端中的配送服务，可以通过插件或后端自定义安装。它保存配送服务的安装状态。

requirements

array[object (Shipping Option Requirement) {6}]

可选

必须满足的要求的详细信息，以便送货选项可用于购物车。

price_incl_tax

number

含税价格

可选

tax_amount

number

适用的税费。

可选

tax_rates

array [object {3}]

应用税率数组

可选

🟠400客户端错误或多个错误

🟠404未找到错误

🟠409无效状态错误

🟠422无效请求错误

🔴500服务器错误