1. Schemas
Medusa 商城 API
v3.0.0
  • latest
  • v2.0.0
  • v3.0.0
  • 商城 API
    • 开始使用
      • 介绍
      • 身份验证
      • HTTP压缩
      • 发布API密钥
      • 扩展字段
      • 选择字段
      • 分页
      • 查询参数类型
    • 身份验证
    • 产品
      • 搜索产品
      • 获取产品列表
      • 获取产品
      • 获取参产品图片
      • 获取参产品视频
      • 获取参产品使用说明
    • 地区
      • 获取地区列表
      • 获取地区
    • 客户信息
      • 请求密码重置
      • 获取保存的支付方式
      • 添加送货地址
      • 更新客户
      • 获取客户
      • 更新送货地址
      • 删除地址
      • 创建客户
      • 重置密码
      • 获取订单列表
    • 产品变体
      • 获取产品变体
      • 获取产品变体
    • 产品标签
      • 获取产品标签列表
    • 产品类别
      • 获取产品类别列表
      • 获取产品类别
    • 文章博客
      • 博客文章
    • 收款
      • 授权付款会话
      • 授权支付会话
      • 刷新支付会话
      • 获取支付集合
      • 管理支付会话
      • 创建支付会话
    • 产品体系
      • 获取产品集合
      • 获取产品集合列表
    • 产品类型
      • 获取产品类型列表
    • 订单编辑
      • 完成订单编辑
      • 检索订单编辑
      • 拒绝订单编辑
    • 退货
      • 创建退货
    • 退货原因
      • 获取退货原因列表
      • 获取退货原因
    • 购物车
      • 创建支付会话
      • 刷新支付会话
      • 创建购物车
      • 更新购物车
      • 完成购物车
      • 获取购物车
      • 选择支付会话
      • 删除支付会话
      • 更新支付会话
      • 添加送货方式
      • 更新订单项
      • 删除订单项
      • 添加订单项
      • 计算购物车税费
      • 删除折扣
    • 物流选项
      • 获取购物车可用物流选项列表
      • 获取物流选项
    • 订单
      • 声明订单
      • 验证订单声明
      • 获取订单
      • 查找订单
      • 按购物车 ID 获取
    • 交换
      • 按购物车ID获取
      • 创建交换
    • 礼品卡
      • 按代码获取礼品卡
    • 开始使用
      • 项目使用说明
  • 未命名接口
    GET
  • 查找订单
    GET
  • Schemas
    • Schemas
      • AdminPostAppsReq
      • ApiResponse
      • UserArray
      • PersonDao
      • AdminPostBatchesReq
      • Category
      • Return
      • StoreReturnsRes
      • AdminPostAuthReq
      • Pet
      • Return Item
      • AdminPostCustomerGroupsGroupCustomersBatchReq
      • Tag
      • StoreOrderEditsRes
      • AdminDeleteCustomerGroupsGroupCustomerBatchReq
      • Order Edit
      • AdminPostCustomersReq
      • User
      • Order Item Change
      • AdminPostCollectionsReq
      • StorePaymentCollectionsRes
      • AdminPostCollectionsCollectionReq
      • Payment Collection
      • AdminCollectionsDeleteRes
      • StorePaymentCollectionsSessionRes
      • AdminDeleteProductsFromCollectionRes
      • Payment Session
      • AdminPostCurrenciesCurrencyReq
      • StoreCompleteCartRes
      • AdminPostCustomerGroupsReq
      • StoreOrdersRes
      • AdminPostProductsToCollectionReq
      • StoreCustomersListOrdersRes
      • AdminDeleteProductsFromCollectionReq
      • Order
      • AdminCustomerGroupsDeleteRes
      • StoreCartsRes
      • AdminPostCustomerGroupsGroupReq
      • Cart
      • AdminPostDiscountsReq
      • StoreSwapsRes
      • AdminPostCustomersCustomerReq
      • Swap
      • AdminPostDiscountsDiscountReq
      • Line Item
      • AdminDiscountsDeleteRes
      • Line Item Adjustment
      • AdminPostDiscountsDiscountConditionsCondition
      • Discount
      • AdminPostDiscountsDiscountDynamicCodesReq
      • StoreGiftCardsRes
      • AdminPostDiscountsDiscountConditions
      • Gift Card
      • AdminPostDiscountsDiscountConditionsConditionBatchReq
      • StoreRegionsListRes
      • AdminDeleteDiscountsDiscountConditionsConditionBatchReq
      • StoreRegionsRes
      • AdminDraftOrdersDeleteRes
      • Region
      • AdminPostDraftOrdersDraftOrderLineItemsItemReq
      • Tax Rate
      • AdminPostDraftOrdersDraftOrderLineItemsReq
      • StoreProductsRes
      • AdminInviteDeleteRes
      • StoreProductsListRes
      • AdminPostNotesReq
      • Priced Product
      • AdminPostNotesNoteReq
      • Product
      • AdminNotesDeleteRes
      • Sales Channel
      • AdminPostNotificationsNotificationResendReq
      • Sales Channel Stock Location
      • AdminOrderEditDeleteRes
      • Discount Rule
      • AdminPostOrderEditsOrderEditReq
      • Shipping Method
      • AdminPostOrderEditsReq
      • StoreShippingOptionsListRes
      • AdminPostInvitesInviteAcceptReq
      • StoreCartShippingOptionsListRes
      • AdminPostOrdersOrderClaimsClaimReq
      • Priced Shipping Option
      • AdminPostOrdersOrderFulfillmentsReq
      • Shipping Option
      • AdminPostOrdersOrderClaimsClaimFulfillmentsReq
      • Shipping Option Requirement
      • AdminPostReservationsReq
      • StoreVariantsListRes
      • AdminOrdersOrderLineItemReservationReq
      • Product Option
      • AdminPostOrdersOrderClaimsClaimShipmentsReq
      • StoreVariantsRes
      • AdminPostOrdersOrderRefundsReq
      • Priced Product Variant
      • AdminPostInventoryItemsInventoryItemReq
      • Product Variant
      • AdminPostGiftCardsReq
      • Money Amount
      • AdminPostInventoryItemsItemLocationLevelsLevelReq
      • Payment
      • AdminPostInventoryItemsReq
      • Shipping Method Tax Line
      • AdminPostInventoryItemsItemLocationLevelsReq
      • Line Item Tax Line
      • AdminPostInvitesReq
      • Product Option Value
      • AdminUpdatePaymentCollectionsReq
      • Product Variant Inventory Item
      • AdminPaymentCollectionDeleteRes
      • Shipping Profile
      • AdminPostPaymentRefundsReq
      • Image
      • AdminPostPriceListsPriceListReq
      • StoreAuthRes
      • AdminPostOrderEditsEditLineItemsLineItemReq
      • StoreCustomersRes
      • AdminPostOrderEditsEditLineItemsReq
      • StoreCustomersResetPasswordRes
      • AdminOrderEditItemChangeDeleteRes
      • Customer
      • AdminPostOrdersOrderReturnsReq
      • Address
      • AdminPostOrdersOrderShipmentReq
      • Gift Card Transaction
      • AdminInventoryItemsDeleteRes
      • Customer Group
      • AdminPostOrdersOrderSwapsSwapShipmentsReq
      • Tax Provider
      • AdminPostGiftCardsGiftCardReq
      • Payment Provider
      • AdminGiftCardsDeleteRes
      • Currency
      • AdminPostPriceListsPriceListPriceListReq
      • Country
      • AdminPostOrdersOrderShippingMethodsReq
      • Fulfillment Provider
      • AdminPostOrdersOrderSwapsSwapFulfillmentsReq
      • StoreCollectionsRes
      • AdminPostOrdersOrderSwapsReq
      • Multiple Errors
      • AdminPriceListDeleteRes
      • StorePostReturnsReq
      • AdminPostRegionsRegionCountriesReq
      • StoreProductTagsListRes
      • Product Tag
      • AdminPriceListDeleteVariantPricesRes
      • StorePostCustomersCustomerReq
      • AdminPostProductCategoriesCategoryProductsBatchReq
      • StorePostCustomersCustomerAddressesAddressReq
      • AdminDeleteProductCategoriesCategoryProductsBatchReq
      • StorePostCartsCartReq
      • AdminPostProductCategoriesCategoryReq
      • StorePostCustomersCustomerAddressesReq
      • AdminProductCategoriesCategoryDeleteRes
      • AddressCreatePayload
      • AdminPostRegionsRegionReq
      • AddressPayload
      • AdminRegionsDeleteRes
      • StoreReturnReasonsRes
      • AdminProductsListTagsRes
      • StoreReturnReasonsListRes
      • AdminPostProductsProductOptionsOption
      • Return Reason
      • AdminPostProductsProductMetadataReq
      • StoreProductTypesListRes
      • AdminPostPublishableApiKeysPublishableApiKeyReq
      • Product Type
      • AdminPostProductsProductReq
      • StoreCollectionsListRes
      • AdminPostRegionsRegionPaymentProvidersReq
      • Product Collection
      • AdminPriceListDeleteBatchRes
      • StoreGetProductCategoriesRes
      • AdminDeletePriceListPricesPricesReq
      • StorePostCartsCartPaymentSessionUpdateReq
      • AdminPostPriceListPricesPricesReq
      • StoreGetProductCategoriesCategoryRes
      • AdminPostProductCategoriesReq
      • Product Category
      • AdminPostRegionsRegionFulfillmentProvidersReq
      • Response Error
      • AdminGetRegionsRegionFulfillmentOptionsRes
      • StorePostSearchRes
      • AdminPriceListDeleteProductPricesRes
      • StoreCustomersListPaymentMethodsRes
      • AdminPostPublishableApiKeysReq
      • StorePostSearchReq
      • AdminPostReservationsReservationReq
      • StorePostCartsCartLineItemsReq
      • AdminReservationsDeleteRes
      • StorePostCartsCartPaymentSessionReq
      • AdminPostProductsProductOptionsReq
      • StorePaymentCollectionSessionsReq
      • AdminProductsDeleteRes
      • StorePostAuthReq
      • AdminPostRegionsReq
      • StorePostPaymentCollectionsBatchSessionsReq
      • AdminPostProductsReq
      • StorePostCustomersReq
      • AdminDeletePublishableApiKeySalesChannelsBatchReq
      • StorePostPaymentCollectionsBatchSessionsAuthorizeReq
      • AdminPostPublishableApiKeySalesChannelsBatchReq
      • StoreBearerAuthRes
      • AdminPostProductsProductVariantsReq
      • StorePostCustomersResetPasswordReq
      • AdminPostProductsProductVariantsVariantReq
      • StorePostOrderEditsOrderEditDecline
      • AdminPostShippingOptionsReq
      • StorePostCustomersCustomerPasswordTokenReq
      • AdminStockLocationsDeleteRes
      • StorePostCustomersCustomerAcceptClaimReq
      • AdminUploadsRes
      • StorePostCustomersCustomerOrderClaimReq
      • AdminDeleteUploadsRes
      • StorePostCartsCartShippingMethodReq
      • AdminBearerAuthRes
      • StoreGetAuthEmailRes
      • AdminCreateUserRequest
      • StorePostCartsCartLineItemsItemReq
      • AdminPostUploadsDownloadUrlReq
      • StorePostCartReq
      • AdminPostTaxRatesTaxRateShippingOptionsReq
      • StorePostSwapsReq
      • AdminDeleteTaxRatesTaxRateShippingOptionsReq
      • AdminPostSalesChannelsChannelProductsBatchReq
      • AdminDeleteSalesChannelsChannelProductsBatchReq
      • AdminPostSalesChannelsSalesChannelReq
      • AdminSalesChannelsDeleteRes
      • AdminPostSalesChannelsChannelStockLocationsReq
      • AdminDeleteSalesChannelsChannelStockLocationsReq
      • AdminSalesChannelsDeleteLocationRes
      • AdminPublishableApiKeyDeleteRes
      • AdminPostTaxRatesTaxRateReq
      • AdminTaxRatesDeleteRes
      • AdminPostTaxRatesTaxRateProductTypesReq
      • AdminDeleteTaxRatesTaxRateProductTypesReq
      • AdminPostTaxRatesTaxRateProductsReq
      • AdminDeleteTaxRatesTaxRateProductsReq
      • OAuth
      • AdminAppsRes
      • AdminResetPasswordRequest
      • AdminUpdateUserRequest
      • AdminDeleteUserRes
      • AdminAuthRes
      • AdminPostTaxRatesReq
      • AdminPostReturnReasonsReasonReq
      • AdminReturnReasonsDeleteRes
      • AdminPostReturnReasonsReq
      • AdminPostReturnsReturnReceiveReq
      • AdminPostSalesChannelsReq
      • AdminPostShippingProfilesReq
      • AdminDeleteShippingProfileRes
      • AdminPostShippingProfilesProfileReq
      • AdminPostShippingOptionsOptionReq
      • AdminShippingOptionsDeleteRes
      • AdminDeleteUploadsReq
      • AdminResetPasswordTokenRequest
      • AdminUploadsDownloadUrlRes
      • AdminAppsListRes
      • AdminPostStoreReq
      • AdminCollectionsListRes
      • AdminCustomerGroupsRes
      • AdminCollectionsRes
      • AdminCustomerGroupsListRes
      • AdminCurrenciesRes
      • AdminCurrenciesListRes
      • DraftOrder
      • AdminDraftOrdersListRes
      • AdminPostDraftOrdersReq
      • AdminDraftOrdersRes
      • AdminPostDraftOrdersDraftOrderReq
      • AdminPostOrdersOrderClaimsReq
      • Invite
      • AdminListInvitesRes
      • Refund
      • AdminRefundRes
      • InventoryLevelDTO
      • AdminInventoryItemsLocationLevelsRes
      • InventoryItemDTO
      • AdminInventoryItemsRes
      • AdminProductTagsListRes
      • AdminProductsListTypesRes
      • AdminProductTypesListRes
      • AdminPublishableApiKeysRes
      • AdminPublishableApiKeysListRes
      • AdminProductCategoriesListRes
      • Reservation item
      • AdminReservationsRes
      • AdminProductCategoriesCategoryRes
      • AdminUsersListRes
      • AdminUserRes
      • Batch Job
      • AdminBatchJobListRes
      • AdminShippingProfilesListRes
      • AdminReturnReasonsRes
      • Stock Location Address Input
      • AdminPostStockLocationsReq
      • AdminShippingProfilesRes
      • AdminBatchJobRes
      • AdminReturnReasonsListRes
      • AdminPostStockLocationsLocationReq
      • AdminPaymentProvidersList
      • AdminTaxProvidersList
      • Note
      • AdminNotesListRes
      • AdminNotesRes
      • Notification Provider
      • AdminPaymentRes
      • AdminShippingOptionsListRes
      • AdminShippingOptionsRes
      • AdminSalesChannelsRes
      • AdminPublishableApiKeysListSalesChannelsRes
      • AdminSalesChannelsListRes
      • FeatureFlagsResponse
      • ModulesResponse
      • AdminCustomersListRes
      • AdminCustomersRes
      • Price List
      • AdminPriceListsListRes
      • AdminPriceListRes
      • AdminProductsListVariantsRes
      • ResponseInventoryItem
      • VariantInventory
      • AdminGetVariantsVariantInventoryRes
      • Stock Location Address
      • Stock Location
      • StockLocationExpandedDTO
      • AdminStockLocationsListRes
      • AdminStockLocationsRes
      • Store
      • AdminStoresRes
      • Notification
      • AdminNotificationsListRes
      • AdminNotificationsRes
      • DecoratedInventoryItemDTO
      • AdminInventoryItemsListWithVariantsAndLocationLevelsRes
      • AdminPriceListsProductsListRes
      • AdminVariantsRes
      • AdminVariantsListRes
      • ExtendedStoreDTO
      • AdminExtendedStoresRes
      • Discount Condition
      • AdminDiscountConditionsRes
      • AdminProductsRes
      • AdminProductsDeleteOptionRes
      • AdminProductsListRes
      • AdminProductsDeleteVariantRes
      • AdminTaxRatesRes
      • AdminTaxRatesListRes
      • AdminRegionsRes
      • AdminRegionsListRes
      • AdminDiscountsListRes
      • AdminDiscountsRes
      • AdminDiscountConditionsDeleteRes
      • AdminGiftCardsRes
      • AdminGiftCardsListRes
      • AdminPostOrdersOrderReq
      • AdminOrdersRes
      • AdminOrdersListRes
      • AdminPostDraftOrdersDraftOrderRegisterPaymentRes
      • ExtendedReservationItem
      • AdminReservationsListRes
      • AdminReturnsCancelRes
      • AdminSwapsRes
      • AdminSwapsListRes
      • AdminReturnsListRes
      • AdminReturnsRes
      • AdminPaymentCollectionsRes
      • AdminOrderEditsRes
      • AdminOrderEditsListRes
      • Response Error
      • Product Category
      • Product Collection
      • Product Type
      • Return Reason
      • AddressPayload1
      • Product Tag
      • Multiple Errors
      • Fulfillment Provider
      • Country
      • Currency
      • Payment Provider
      • Tax Provider
      • Customer Group
      • Gift Card Transaction
      • Address
      • Customer
      • Image
      • Shipping Profile
      • Product Variant Inventory Item
      • Product Option Value
      • Line Item Tax Line
      • Shipping Method Tax Line
      • Payment
      • Money Amount
      • Product Variant
      • Priced Product Variant
      • Product Option
      • Shipping Option Requirement
      • Shipping Option
      • Shipping Method
      • Discount Rule
      • Sales Channel Stock Location
      • Sales Channel
      • Product
      • Priced Product
      • Tax Rate
      • Region
      • Gift Card
      • Discount
      • Line Item Adjustment
      • Line Item
      • Swap
      • Cart
      • Order
      • Payment Session
      • Payment Collection
      • Order Item Change
      • Order Edit
      • Return Item
      • Return
    • RequestBodies
    • Store API
      • Schemas
    • Admin API
      • Schemas
        • Response Error
        • Product Collection
        • Customer Group
        • Currency
        • AddressPayload
        • Product Tag
        • Product Type
        • Product Category
        • Shipping Profile
        • Return Reason
        • Payment Provider
        • Tax Provider
        • Multiple Errors
        • Discount Rule
        • Gift Card Transaction
        • Payment
        • Line Item Tax Line
        • Country
        • Fulfillment Provider
        • Image
        • Product Variant Inventory Item
        • Product Option Value
        • Shipping Option Requirement
        • Shipping Option
        • Sales Channel Stock Location
        • Sales Channel
        • Address
        • Customer
        • Shipping Method Tax Line
        • Money Amount
        • Product Option
        • Product Variant
        • Shipping Method
        • Product
        • Priced Product Variant
        • Priced Product
        • Tax Rate
        • Region
        • Discount
        • Gift Card
        • Line Item Adjustment
        • Line Item
        • Order
        • Swap
        • Order Item Change
        • Return Item
        • Return
        • Cart
        • Payment Session
        • Payment Collection
        • Order Edit
  1. Schemas

ShippingOption(Shipping Option)

A Shipping Option represents a way in which an Order or Return can be shipped. Shipping Options have an associated Fulfillment Provider that will be used when the fulfillment of an Order is initiated. Shipping Options themselves cannot be added to Carts, but serve as a template for Shipping Methods. This distinction makes it possible to customize individual Shipping Methods with additional information.

{
    "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:22.123Z",
    "updated_at": "2019-08-24T14:15:22.123Z",
    "deleted_at": "2019-08-24T14:15:22.123Z",
    "price_type": "flat_rate",
    "data": {},
    "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:22.123Z",
            "type": "min_subtotal"
        }
    ],
    "profile": {
        "id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
        "name": "Default Shipping Profile",
        "created_at": "2019-08-24T14:15:22.123Z",
        "updated_at": "2019-08-24T14:15:22.123Z",
        "deleted_at": "2019-08-24T14:15:22.123Z",
        "type": "default",
        "products": [
            {}
        ],
        "shipping_options": [
            {}
        ],
        "metadata": {
            "car": "white"
        }
    }
}
Built with