1. Schemas
22
  • 🦊一分钟,了解 Apifox !
  • 示例项目
    • 查询宠物详情
    • 新建宠物信息
    • 修改宠物信息
    • 删除宠物信息
    • 根据状态查找宠物列表
  • Orders
    • Claim Order
    • Verify Order Claim
    • Get by Cart ID
    • Get an Order
    • Look Up an Order
  • Product Tags
    • List Product Tags
  • Auth
    • Check if Email Exists
    • Customer Log out
    • Get Current Customer
    • Customer Login
  • Customers
    • Get Saved Payment Methods
    • Request Password Reset
    • Delete an Address
    • Update a Shipping Address
    • Create a Customer
    • Add a Shipping Address
    • Reset Password
    • Update Customer
    • Get a Customer
    • List Orders
  • Product Collections
    • List Collections
    • Get a Collection
  • Return Reasons
    • List Return Reasons
    • Get a Return Reason
  • Product Categories
    • List Product Categories
    • Get a Product Category
  • Product Types
    • List Product Types
  • Products
    • Search Products
    • List Products
    • Get a Product
  • Product Variants
    • Get Product Variants
    • Get a Product Variant
  • Shipping Options
    • List for Cart
    • Get Shipping Options
  • Regions
    • Get a Region
    • List Regions
  • Carts
    • Select a Payment Session
    • Create Payment Sessions
    • Calculate Cart Taxes
    • Delete a Payment Session
    • Update a Payment Session
    • Update a Line Item
    • Delete a Line Item
    • Add Shipping Method
    • Remove Discount
    • Complete a Cart
    • Create a Cart
    • Get a Cart
    • Update a Cart
    • Add a Line Item
    • Refresh a Payment Session
  • Gift Cards
    • Get Gift Card by Code
  • Swaps
    • Create a Swap
    • Get by Cart ID
  • Order Edits
    • Decline an Order Edit
    • Retrieve an Order Edit
    • Complete an Order Edit
  • Payment Collections
    • Authorize Payment Sessions
    • Refresh a Payment Session
    • Create a Payment Session
    • Get a PaymentCollection
    • Authorize Payment Session
    • Manage Payment Sessions
  • Returns
    • Create Return
  • 11111
    POST
  • 数据模型
    • 示例数据模型
      • Pet
      • Category
      • Tag
    • Schemas
      • StorePostOrderEditsOrderEditDecline
      • StorePostCartsCartLineItemsReq
      • StorePostCustomersCustomerOrderClaimReq
      • StorePostCartsCartPaymentSessionReq
      • StorePostCartsCartLineItemsItemReq
      • StorePaymentCollectionSessionsReq
      • StoreCustomersListPaymentMethodsRes
      • Response Error
      • StorePostPaymentCollectionsBatchSessionsAuthorizeReq
      • StorePostCartReq
      • StorePostSwapsReq
      • StorePostSearchReq
      • StoreGetAuthEmailRes
      • Multiple Errors
      • StorePostCustomersCustomerAcceptClaimReq
      • StorePostCustomersResetPasswordReq
      • StorePostCartsCartShippingMethodReq
      • StorePostReturnsReq
      • Product Collection
      • StoreCollectionsListRes
      • AddressPayload
      • StorePostCustomersCustomerAddressesAddressReq
      • Product Category
      • StoreGetProductCategoriesCategoryRes
      • StorePostAuthReq
      • StorePostCustomersReq
      • Return Reason
      • StoreReturnReasonsListRes
      • Gift Card Transaction
      • Currency
      • StorePostSearchRes
      • Product Tag
      • StoreProductTagsListRes
      • StorePostCustomersCustomerPasswordTokenReq
      • Shipping Method Tax Line
      • Country
      • Address
      • Tax Provider
      • Payment Provider
      • Fulfillment Provider
      • Customer Group
      • StorePostCartsCartPaymentSessionUpdateReq
      • Discount Rule
      • StorePostCartsCartReq
      • Line Item Tax Line
      • Customer
      • StoreAuthRes
      • Sales Channel Stock Location
      • Sales Channel
      • StoreCustomersRes
      • StoreCollectionsRes
      • Shipping Option Requirement
      • StoreGetProductCategoriesRes
      • Shipping Profile
      • Shipping Option
      • Shipping Method
      • StorePostPaymentCollectionsBatchSessionsReq
      • Product Type
      • StoreProductTypesListRes
      • Payment
      • StoreReturnReasonsRes
      • AddressCreatePayload
      • StorePostCustomersCustomerAddressesReq
      • Product Variant Inventory Item
      • Product Option Value
      • Image
      • Money Amount
      • Product Variant
      • StorePostCustomersCustomerReq
      • Product Option
      • Product
      • Tax Rate
      • Region
      • Discount
      • Priced Product Variant
      • StoreVariantsListRes
      • StoreCustomersResetPasswordRes
      • StoreVariantsRes
      • Priced Shipping Option
      • StoreCartShippingOptionsListRes
      • Gift Card
      • Priced Product
      • StoreProductsListRes
      • StoreShippingOptionsListRes
      • StoreProductsRes
      • Line Item Adjustment
      • Line Item
      • StoreRegionsRes
      • Cart
      • StoreCartsRes
      • StoreGiftCardsRes
      • StoreRegionsListRes
      • Swap
      • StoreSwapsRes
      • Order
      • StoreOrdersRes
      • Order Item Change
      • StoreCompleteCartRes
      • Payment Session
      • Payment Collection
      • Order Edit
      • StoreOrderEditsRes
      • StoreCustomersListOrdersRes
      • StorePaymentCollectionsRes
      • Return Item
      • Return
      • StoreReturnsRes
      • StorePaymentCollectionsSessionRes
  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"
    },
    "requirements": [
        {
            "id": "sor_01G1G5V29AB4CTNDRFSRWSRKWD",
            "shipping_option_id": "so_01G1G5V27GYX4QXNARRQCW1N8T",
            "shipping_option": {},
            "amount": 100,
            "deleted_at": "2019-08-24T14:15:22.123Z",
            "type": "min_subtotal"
        }
    ],
    "provider": {
        "id": "manual",
        "is_installed": true
    },
    "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