Medusa API
  1. Schemas
Medusa API
  • Store API
  • Admin API
    • Auth
      • Apps Oauth
        • Generate Token for App
        • List Applications
      • Get Current User
      • User Logout
      • User Login
      • User Login (JWT)
    • Batch Jobs
      • Cancel a Batch Job
      • Get a Batch Job
      • Confirm a Batch Job
      • List Batch Jobs
      • Create a Batch Job
    • Currencies
      • List Currency
      • Update a Currency
    • Customers
      • Create a Customer
      • List Customers
      • Update a Customer
      • Get a Customer
    • Customer Groups
      • Remove Customers from Group
      • Add Customers to Group
      • List Customers
      • Create a Customer Group
      • List Customer Groups
      • Get a Customer Group
      • Delete a Customer Group
      • Update a Customer Group
    • Discounts
      • Create a Condition
      • Create a Discount
      • List Discounts
      • Get a Condition
      • Update a Condition
      • Delete a Condition
      • Create a Dynamic Code
      • Remove Batch Resources
      • Add Batch Resources
      • Get Discount by Code
      • Delete a Dynamic Code
      • Add Region to Discount
      • Remove Region
      • Delete a Discount
      • Update a Discount
      • Get a Discount
    • Draft Orders
      • Create a Line Item
      • Delete a Line Item
      • Update a Line Item
      • Update a Draft Order
      • Delete a Draft Order
      • Get a Draft Order
      • Create a Draft Order
      • List Draft Orders
      • Mark Paid
    • Gift Cards
      • Create a Gift Card
      • List Gift Cards
      • Delete a Gift Card
      • Get a Gift Card
      • Update a Gift Card
    • Inventory Items
      • Create an Inventory Item
      • List Inventory Items
      • List Inventory Level
      • Create an Location Level
      • Update an Inventory Item
      • Get an Inventory Item
      • Delete an Inventory Item
      • Update a Location Level
      • Delete a Location Level
    • Invites
      • Lists Invites
      • Create an Invite
      • Delete an Invite
      • Accept an Invite
      • Resend an Invite
    • Notes
      • List Notes
      • Create a Note
      • Get a Note
      • Delete a Note
      • Update a Note
    • Notifications
      • Resend Notification
      • List Notifications
    • Orders
      • Create a Reservation
      • Cancel Claim's Fulfillment
      • Ship a Claim's Fulfillment
      • Cancel Swap's Fulfilmment
      • Get Order Reservations
      • Add a Shipping Method
      • Create a Refund
      • Get an Order
      • Update an Order
      • Create a Fulfillment
      • Cancel a Swap
      • List Orders
      • Create a Swap
      • Complete an Order
      • Create a Swap Fulfillment
      • Cancel a Claim
      • Process a Swap Payment
      • Ship a Fulfillment
      • Capture an Order's Payments
      • Archive Order
      • Update a Claim
      • Request a Return
      • Create a Claim Fulfillment
      • Ship a Swap's Fulfillment
      • Cancel a Fulfilmment
      • Create a Claim
      • Cancel an Order
    • Order Edits
      • Delete a Line Item Change
      • Add a Line Item
      • Upsert Line Item Change
      • Delete Line Item
      • Cancel an Order Edit
      • Delete an Order Edit
      • Get an Order Edit
      • Update an Order Edit
      • Request Confirmation
      • Create an OrderEdit
      • List Order Edits
      • Confirm an OrderEdit
    • Payments
      • Capture a Payment
      • Get Payment details
      • Refund Payment
    • Payment Collections
      • Delete a Payment Collection
      • Get a Payment Collection
      • Update Payment Collection
      • Mark Authorized
    • Product Collections
      • Add Products to Collection
      • Remove Products from Collection
      • Get a Collection
      • Update a Collection
      • Delete a Collection
      • List Collections
      • Create a Collection
    • Product Tags
      • List Product Tags
    • Product Types
      • List Product Types
    • Product Variants
      • Get Variant's Inventory
      • List Product Variants
      • Get a Product variant
    • Price Lists
      • Delete a Product's Prices
      • List Products
      • Delete a Variant's Prices
      • Get a Price List
      • Update a Price List
      • Delete a Price List
      • Add or Update Prices
      • Delete Prices
      • Create a Price List
      • List Price Lists
    • Products
      • List Product Types
      • List Tags Usage Number
      • List a Product's Variants
      • Create a Product Variant
      • Update a Product Variant
      • Delete a Product Variant
      • Add a Product Option
      • Set Metadata
      • Delete a Product Option
      • Update a Product Option
    • Product Categories
      • Create a Product Category
      • List Product Categories
      • Update a Product Category
      • Delete a Product Category
      • Get a Product Category
      • Add Products to a Category
      • Remove Products from Category
    • Publishable Api Keys
      • List Sales Channels
      • Delete Publishable API Key
      • Get a Publishable API Key
      • Revoke a Publishable API Key
      • Remove Sales Channels
      • Add Sales Channels
      • Update Publishable API Key
      • List Publishable API keys
      • Create Publishable API Key
    • Reservations
      • Delete a Reservation
      • Update a Reservation
      • Get a Reservation
      • Create a Reservation
      • List Reservations
    • Regions
      • List Fulfillment Options
      • Add Country
      • Remove Fulfillment Provider
      • Remove Payment Provider
      • Add Payment Provider
      • Delete a Region
      • Update a Region
      • Get a Region
      • List Regions
      • Create a Region
      • Add Fulfillment Provider
      • Remove Country
    • Return Reasons
      • Get a Return Reason
      • Delete a Return Reason
      • Update a Return Reason
      • List Return Reasons
      • Create a Return Reason
    • Returns
      • Receive a Return
      • List Returns
      • Cancel a Return
    • Sales Channels
      • Remove Stock Location from Sales Channels.
      • Associate a Stock Location
      • Get a Sales Channel
      • Delete a Sales Channel
      • Update a Sales Channel
      • Remove Products from Sales Channel
      • Add Products to Sales Channel
      • Create a Sales Channel
      • List Sales Channels
    • Shipping Options
      • Update Shipping Option
      • Get a Shipping Option
      • Delete Shipping Option
      • List Shipping Options
      • Create Shipping Option
    • Shipping Profiles
      • List Shipping Profiles
      • Create a Shipping Profile
      • Delete a Shipping Profile
      • Update a Shipping Profile
      • Get a Shipping Profile
    • Stock Locations
      • Get a Stock Location
      • Update a Stock Location
      • Delete a Stock Location
      • List Stock Locations
      • Create a Stock Location
    • Store
      • List Payment Providers
      • Add a Currency Code
      • Remove a Currency
      • List Tax Providers
      • Update Store Details
      • Get Store details
    • Swaps
      • Get a Swap
      • List Swaps
    • Uploads
      • Upload Files
      • Delete an Uploaded File
      • Get a File's Download URL
      • Protected File Upload
    • Tax Rates
      • Add to Shipping Options
      • Remove Shipping Options from Rate
      • Create a Tax Rate
      • List Tax Rates
      • Add to Products
      • Remove Products from Rate
      • Delete a Tax Rate
      • Get a Tax Rate
      • Update a Tax Rate
      • Add to Product Types
      • Remove Product Types from Rate
    • Users
      • Reset Password
      • Request Password Reset
      • Get a User
      • Delete a User
      • Update a User
      • Create a User
      • List Users
  • 【Demo】Products
    • 检索产品列表
    • 创建新产品
    • 删除产品
    • 更新产品信息
    • 检索产品详情
  • Schemas
    • Schemas
      • Return Copy
      • AdminOrderEditsListRes
      • AdminOrderEditsRes
      • Order Edit
      • AdminPaymentCollectionsRes
      • Payment Collection
      • Payment Session
      • Cart
      • AdminReturnsRes
      • AdminReturnsListRes
      • Return
      • Return Item
      • Order Item Change
      • AdminSwapsListRes
      • AdminSwapsRes
      • Swap
      • AdminReturnsCancelRes
      • AdminReservationsListRes
      • ExtendedReservationItem
      • AdminPostDraftOrdersDraftOrderRegisterPaymentRes
      • AdminOrdersListRes
      • AdminOrdersRes
      • Order
      • AdminPostOrdersOrderReq
      • Line Item
      • Line Item Adjustment
      • AdminGiftCardsListRes
      • AdminGiftCardsRes
      • Gift Card
      • AdminDiscountConditionsDeleteRes
      • AdminDiscountsRes
      • AdminDiscountsListRes
      • Discount
      • AdminRegionsListRes
      • AdminRegionsRes
      • Region
      • AdminTaxRatesListRes
      • AdminTaxRatesRes
      • Tax Rate
      • AdminProductsDeleteVariantRes
      • AdminProductsListRes
      • AdminProductsDeleteOptionRes
      • AdminProductsRes
      • Priced Product
      • AdminDiscountConditionsRes
      • Discount Condition
      • AdminExtendedStoresRes
      • ExtendedStoreDTO
      • AdminVariantsListRes
      • AdminVariantsRes
      • Priced Product Variant
      • AdminPriceListsProductsListRes
      • AdminInventoryItemsListWithVariantsAndLocationLevelsRes
      • DecoratedInventoryItemDTO
      • Shipping Method
      • AdminNotificationsRes
      • AdminNotificationsListRes
      • Notification
      • AdminStoresRes
      • Store
      • AdminStockLocationsRes
      • AdminStockLocationsListRes
      • StockLocationExpandedDTO
      • Stock Location
      • Stock Location Address
      • AdminGetVariantsVariantInventoryRes
      • VariantInventory
      • ResponseInventoryItem
      • AdminProductsListVariantsRes
      • Product Variant
      • Product Option
      • AdminPriceListRes
      • AdminPriceListsListRes
      • Price List
      • Money Amount
      • Shipping Method Tax Line
      • AdminCustomersRes
      • AdminCustomersListRes
      • Customer
      • Address
      • ModulesResponse
      • FeatureFlagsResponse
      • AdminSalesChannelsListRes
      • AdminPublishableApiKeysListSalesChannelsRes
      • AdminSalesChannelsRes
      • Sales Channel
      • Sales Channel Stock Location
      • AdminShippingOptionsRes
      • AdminShippingOptionsListRes
      • Shipping Option
      • Shipping Option Requirement
      • Product Option Value
      • Product Variant Inventory Item
      • Image
      • Fulfillment Provider
      • Country
      • Line Item Tax Line
      • AdminPaymentRes
      • Payment
      • Gift Card Transaction
      • Notification Provider
      • AdminNotesRes
      • AdminNotesListRes
      • Note
      • Discount Rule
      • Multiple Errors
      • AdminTaxProvidersList
      • Tax Provider
      • AdminPaymentProvidersList
      • Payment Provider
      • AdminPostStockLocationsLocationReq
      • AdminReturnReasonsListRes
      • AdminBatchJobRes
      • AdminShippingProfilesRes
      • AdminPostStockLocationsReq
      • Stock Location Address Input
      • AdminReturnReasonsRes
      • Return Reason
      • AdminShippingProfilesListRes
      • Shipping Profile
      • AdminBatchJobListRes
      • Batch Job
      • AdminUserRes
      • AdminUsersListRes
      • AdminProductCategoriesCategoryRes
      • AdminReservationsRes
      • Reservation item
      • AdminProductCategoriesListRes
      • Product Category
      • AdminPublishableApiKeysListRes
      • AdminPublishableApiKeysRes
      • AdminProductTypesListRes
      • AdminProductsListTypesRes
      • Product Type
      • AdminProductTagsListRes
      • Product Tag
      • AdminInventoryItemsRes
      • InventoryItemDTO
      • AdminInventoryItemsLocationLevelsRes
      • InventoryLevelDTO
      • AdminRefundRes
      • Refund
      • AdminListInvitesRes
      • Invite
      • AdminPostOrdersOrderClaimsReq
      • AdminPostDraftOrdersDraftOrderReq
      • AdminDraftOrdersRes
      • AdminPostDraftOrdersReq
      • AdminDraftOrdersListRes
      • DraftOrder
      • AddressPayload
      • AdminCurrenciesListRes
      • AdminCurrenciesRes
      • Currency
      • AdminCustomerGroupsListRes
      • AdminCollectionsRes
      • AdminCustomerGroupsRes
      • Customer Group
      • AdminCollectionsListRes
      • Product Collection
      • AdminPostStoreReq
      • AdminAppsListRes
      • AdminUploadsDownloadUrlRes
      • AdminResetPasswordTokenRequest
      • AdminDeleteUploadsReq
      • AdminShippingOptionsDeleteRes
      • AdminPostShippingOptionsOptionReq
      • AdminPostShippingProfilesProfileReq
      • AdminDeleteShippingProfileRes
      • AdminPostShippingProfilesReq
      • AdminPostSalesChannelsReq
      • AdminPostReturnsReturnReceiveReq
      • AdminPostReturnReasonsReq
      • AdminReturnReasonsDeleteRes
      • AdminPostReturnReasonsReasonReq
      • AdminPostTaxRatesReq
      • AdminAuthRes
      • User
      • AdminDeleteUserRes
      • AdminUpdateUserRequest
      • AdminResetPasswordRequest
      • AdminAppsRes
      • OAuth
      • AdminDeleteTaxRatesTaxRateProductsReq
      • AdminPostTaxRatesTaxRateProductsReq
      • AdminDeleteTaxRatesTaxRateProductTypesReq
      • AdminPostTaxRatesTaxRateProductTypesReq
      • AdminTaxRatesDeleteRes
      • AdminPostTaxRatesTaxRateReq
      • Response Error
      • AdminPublishableApiKeyDeleteRes
      • AdminSalesChannelsDeleteLocationRes
      • AdminDeleteSalesChannelsChannelStockLocationsReq
      • AdminPostSalesChannelsChannelStockLocationsReq
      • AdminSalesChannelsDeleteRes
      • AdminPostSalesChannelsSalesChannelReq
      • AdminDeleteSalesChannelsChannelProductsBatchReq
      • AdminPostSalesChannelsChannelProductsBatchReq
      • StoreReturnsRes
      • AdminDeleteTaxRatesTaxRateShippingOptionsReq
      • Return
      • AdminPostTaxRatesTaxRateShippingOptionsReq
      • Return Item
      • AdminPostUploadsDownloadUrlReq
      • StoreOrderEditsRes
      • AdminCreateUserRequest
      • Order Edit
      • AdminBearerAuthRes
      • Order Item Change
      • AdminDeleteUploadsRes
      • StorePaymentCollectionsRes
      • AdminUploadsRes
      • Payment Collection
      • AdminStockLocationsDeleteRes
      • StorePaymentCollectionsSessionRes
      • AdminPostShippingOptionsReq
      • Payment Session
      • AdminPostProductsProductVariantsVariantReq
      • StoreCompleteCartRes
      • AdminPostProductsProductVariantsReq
      • StoreOrdersRes
      • AdminPostPublishableApiKeySalesChannelsBatchReq
      • StoreCustomersListOrdersRes
      • AdminDeletePublishableApiKeySalesChannelsBatchReq
      • Order
      • AdminPostProductsReq
      • StoreCartsRes
      • AdminPostRegionsReq
      • Cart
      • AdminProductsDeleteRes
      • StoreSwapsRes
      • AdminPostProductsProductOptionsReq
      • Swap
      • AdminReservationsDeleteRes
      • Line Item
      • AdminPostReservationsReservationReq
      • Line Item Adjustment
      • AdminPostPublishableApiKeysReq
      • Discount
      • AdminPriceListDeleteProductPricesRes
      • StoreGiftCardsRes
      • AdminGetRegionsRegionFulfillmentOptionsRes
      • Gift Card
      • AdminPostRegionsRegionFulfillmentProvidersReq
      • StoreRegionsListRes
      • AdminPostProductCategoriesReq
      • StoreRegionsRes
      • AdminPostPriceListPricesPricesReq
      • Region
      • AdminDeletePriceListPricesPricesReq
      • Tax Rate
      • AdminPriceListDeleteBatchRes
      • StoreProductsRes
      • AdminPostRegionsRegionPaymentProvidersReq
      • StoreProductsListRes
      • AdminPostProductsProductReq
      • Priced Product
      • AdminPostPublishableApiKeysPublishableApiKeyReq
      • Product
      • AdminPostProductsProductMetadataReq
      • Sales Channel
      • AdminPostProductsProductOptionsOption
      • Sales Channel Stock Location
      • AdminProductsListTagsRes
      • Discount Rule
      • AdminRegionsDeleteRes
      • Shipping Method
      • AdminPostRegionsRegionReq
      • StoreShippingOptionsListRes
      • AdminProductCategoriesCategoryDeleteRes
      • StoreCartShippingOptionsListRes
      • AdminPostProductCategoriesCategoryReq
      • Priced Shipping Option
      • AdminDeleteProductCategoriesCategoryProductsBatchReq
      • Shipping Option
      • AdminPostProductCategoriesCategoryProductsBatchReq
      • Shipping Option Requirement
      • AdminPriceListDeleteVariantPricesRes
      • StoreVariantsListRes
      • AdminPostRegionsRegionCountriesReq
      • Product Option
      • AdminPriceListDeleteRes
      • StoreVariantsRes
      • AdminPostOrdersOrderSwapsReq
      • Priced Product Variant
      • AdminPostOrdersOrderSwapsSwapFulfillmentsReq
      • Product Variant
      • AdminPostOrdersOrderShippingMethodsReq
      • Money Amount
      • AdminPostPriceListsPriceListPriceListReq
      • Payment
      • AdminGiftCardsDeleteRes
      • Shipping Method Tax Line
      • AdminPostGiftCardsGiftCardReq
      • Line Item Tax Line
      • AdminPostOrdersOrderSwapsSwapShipmentsReq
      • Product Option Value
      • AdminInventoryItemsDeleteRes
      • Product Variant Inventory Item
      • AdminPostOrdersOrderShipmentReq
      • Shipping Profile
      • AdminPostOrdersOrderReturnsReq
      • Image
      • AdminOrderEditItemChangeDeleteRes
      • StoreAuthRes
      • AdminPostOrderEditsEditLineItemsReq
      • StoreCustomersRes
      • AdminPostOrderEditsEditLineItemsLineItemReq
      • StoreCustomersResetPasswordRes
      • AdminPostPriceListsPriceListReq
      • Customer
      • AdminPostPaymentRefundsReq
      • Address
      • AdminPaymentCollectionDeleteRes
      • Gift Card Transaction
      • AdminUpdatePaymentCollectionsReq
      • Customer Group
      • AdminPostInvitesReq
      • Tax Provider
      • AdminPostInventoryItemsItemLocationLevelsReq
      • Payment Provider
      • AdminPostInventoryItemsReq
      • Currency
      • AdminPostInventoryItemsItemLocationLevelsLevelReq
      • Country
      • AdminPostGiftCardsReq
      • Fulfillment Provider
      • AdminPostInventoryItemsInventoryItemReq
      • StoreCollectionsRes
      • AdminPostOrdersOrderRefundsReq
      • Multiple Errors
      • AdminPostOrdersOrderClaimsClaimShipmentsReq
      • StorePostReturnsReq
      • AdminOrdersOrderLineItemReservationReq
      • StoreProductTagsListRes
      • AdminPostReservationsReq
      • Product Tag
      • AdminPostOrdersOrderClaimsClaimFulfillmentsReq
      • StorePostCustomersCustomerReq
      • AdminPostOrdersOrderFulfillmentsReq
      • StorePostCustomersCustomerAddressesAddressReq
      • AdminPostOrdersOrderClaimsClaimReq
      • StorePostCartsCartReq
      • AdminPostInvitesInviteAcceptReq
      • StorePostCustomersCustomerAddressesReq
      • AdminPostOrderEditsReq
      • AddressCreatePayload
      • AdminPostOrderEditsOrderEditReq
      • AddressPayload1
      • AdminOrderEditDeleteRes
      • StoreReturnReasonsRes
      • AdminPostNotificationsNotificationResendReq
      • StoreReturnReasonsListRes
      • AdminNotesDeleteRes
      • Return Reason
      • AdminPostNotesNoteReq
      • StoreProductTypesListRes
      • AdminPostNotesReq
      • Product Type
      • AdminInviteDeleteRes
      • StoreCollectionsListRes
      • AdminPostDraftOrdersDraftOrderLineItemsReq
      • Product Collection
      • AdminPostDraftOrdersDraftOrderLineItemsItemReq
      • StoreGetProductCategoriesRes
      • AdminDraftOrdersDeleteRes
      • StorePostCartsCartPaymentSessionUpdateReq
      • AdminDeleteDiscountsDiscountConditionsConditionBatchReq
      • StoreGetProductCategoriesCategoryRes
      • AdminPostDiscountsDiscountConditionsConditionBatchReq
      • Product Category
      • AdminPostDiscountsDiscountConditions
      • Response Error
      • AdminPostDiscountsDiscountDynamicCodesReq
      • StorePostSearchRes
      • AdminPostDiscountsDiscountConditionsCondition
      • StoreCustomersListPaymentMethodsRes
      • AdminDiscountsDeleteRes
      • StorePostSearchReq
      • AdminPostDiscountsDiscountReq
      • StorePostCartsCartLineItemsReq
      • AdminPostCustomersCustomerReq
      • StorePostCartsCartPaymentSessionReq
      • AdminPostDiscountsReq
      • StorePaymentCollectionSessionsReq
      • AdminPostCustomerGroupsGroupReq
      • StorePostAuthReq
      • AdminCustomerGroupsDeleteRes
      • StorePostPaymentCollectionsBatchSessionsReq
      • AdminDeleteProductsFromCollectionReq
      • StorePostCustomersReq
      • AdminPostProductsToCollectionReq
      • StorePostPaymentCollectionsBatchSessionsAuthorizeReq
      • AdminPostCustomerGroupsReq
      • StoreBearerAuthRes
      • AdminPostCurrenciesCurrencyReq
      • StorePostCustomersResetPasswordReq
      • AdminDeleteProductsFromCollectionRes
      • StorePostOrderEditsOrderEditDecline
      • AdminCollectionsDeleteRes
      • StorePostCustomersCustomerPasswordTokenReq
      • AdminPostCollectionsCollectionReq
      • StorePostCustomersCustomerAcceptClaimReq
      • AdminPostCollectionsReq
      • StorePostCustomersCustomerOrderClaimReq
      • AdminPostCustomersReq
      • StorePostCartsCartShippingMethodReq
      • AdminDeleteCustomerGroupsGroupCustomerBatchReq
      • StoreGetAuthEmailRes
      • AdminPostCustomerGroupsGroupCustomersBatchReq
      • StorePostCartsCartLineItemsItemReq
      • AdminPostAuthReq
      • StorePostCartReq
      • AdminPostBatchesReq
      • StorePostSwapsReq
      • AdminPostAppsReq
    • store
    • 产品
  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:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "deleted_at": "2019-08-24T14:15:22Z",
    "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:22Z",
            "type": "min_subtotal"
        }
    ],
    "profile": {
        "id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
        "name": "Default Shipping Profile",
        "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"
        }
    }
}
Built with