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

PricedProduct(Priced Product)

{
    "id": "prod_01G1G5V2MBA328390B5AXJ610F",
    "title": "Medusa Coffee Mug",
    "subtitle": "string",
    "description": "Every programmer's best friend.",
    "handle": "coffee-mug",
    "is_giftcard": false,
    "thumbnail": "http://example.com",
    "profile_id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
    "weight": null,
    "length": null,
    "height": null,
    "width": null,
    "hs_code": null,
    "origin_country": null,
    "mid_code": null,
    "material": null,
    "collection_id": "pcol_01F0YESBFAZ0DV6V831JXWH0BG",
    "type_id": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A",
    "discountable": true,
    "external_id": null,
    "created_at": "2019-08-24T14:15:22.123Z",
    "updated_at": "2019-08-24T14:15:22.123Z",
    "deleted_at": "2019-08-24T14:15:22.123Z",
    "status": "draft",
    "metadata": {
        "car": "white"
    },
    "tags": [
        {
            "id": "ptag_01G8K2MTMG9168F2B70S1TAVK3",
            "value": "Pants",
            "created_at": "2019-08-24T14:15:22.123Z",
            "updated_at": "2019-08-24T14:15:22.123Z",
            "deleted_at": "2019-08-24T14:15:22.123Z",
            "metadata": {
                "car": "white"
            }
        }
    ],
    "images": [
        {
            "id": "img_01G749BFYR6T8JTVW6SGW3K3E6",
            "url": "http://example.com",
            "created_at": "2019-08-24T14:15:22.123Z",
            "updated_at": "2019-08-24T14:15:22.123Z",
            "deleted_at": "2019-08-24T14:15:22.123Z",
            "metadata": {
                "car": "white"
            }
        }
    ],
    "categories": [
        {
            "id": "pcat_01G2SG30J8C85S4A5CHM2S1NS2",
            "name": "Regular Fit",
            "handle": "regular-fit",
            "mpath": "pcat_id1.pcat_id2.pcat_id3",
            "is_internal": false,
            "is_active": false,
            "rank": 0,
            "parent_category_id": null,
            "parent_category": {},
            "created_at": "2019-08-24T14:15:22.123Z",
            "updated_at": "2019-08-24T14:15:22.123Z",
            "category_children": [
                {}
            ],
            "products": [
                {}
            ]
        }
    ],
    "collection": {
        "id": "pcol_01F0YESBFAZ0DV6V831JXWH0BG",
        "title": "Summer Collection",
        "handle": "summer-collection",
        "created_at": "2019-08-24T14:15:22.123Z",
        "updated_at": "2019-08-24T14:15:22.123Z",
        "deleted_at": "2019-08-24T14:15:22.123Z",
        "products": [
            {}
        ],
        "metadata": {
            "car": "white"
        }
    },
    "sales_channels": [
        {
            "id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A",
            "name": "Market",
            "description": "Multi-vendor market",
            "is_disabled": 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",
            "metadata": {
                "car": "white"
            },
            "locations": [
                {
                    "id": "scloc_01G8X9A7ESKAJXG2H0E6F1MW7A",
                    "sales_channel_id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A",
                    "location_id": "string",
                    "sales_channel": {},
                    "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": {
        "id": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A",
        "value": "Clothing",
        "created_at": "2019-08-24T14:15:22.123Z",
        "updated_at": "2019-08-24T14:15:22.123Z",
        "deleted_at": "2019-08-24T14:15:22.123Z",
        "metadata": {
            "car": "white"
        }
    },
    "variants": [
        {
            "id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
            "title": "Small",
            "product_id": "prod_01G1G5V2MBA328390B5AXJ610F",
            "product": {},
            "sku": "shirt-123",
            "barcode": null,
            "ean": null,
            "upc": null,
            "variant_rank": 0,
            "inventory_quantity": 100,
            "allow_backorder": false,
            "manage_inventory": true,
            "hs_code": null,
            "origin_country": null,
            "mid_code": null,
            "material": null,
            "weight": null,
            "length": null,
            "height": null,
            "width": null,
            "created_at": "2019-08-24T14:15:22.123Z",
            "updated_at": "2019-08-24T14:15:22.123Z",
            "deleted_at": "2019-08-24T14:15:22.123Z",
            "purchasable": true,
            "metadata": {
                "car": "white"
            },
            "inventory_items": [
                {
                    "id": "pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A",
                    "inventory_item_id": "string",
                    "variant_id": "string",
                    "variant": {},
                    "required_quantity": 1,
                    "created_at": "2019-08-24T14:15:22.123Z",
                    "updated_at": "2019-08-24T14:15:22.123Z",
                    "deleted_at": "2019-08-24T14:15:22.123Z"
                }
            ],
            "prices": [
                {
                    "id": "ma_01F0YESHRFQNH5S8Q0PK84YYZN",
                    "amount": 100,
                    "min_quantity": 1,
                    "max_quantity": 1,
                    "price_list_id": "pl_01G8X3CKJXCG5VXVZ87H9KC09W",
                    "price_list": {},
                    "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                    "variant": {},
                    "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
                    "region": {},
                    "created_at": "2019-08-24T14:15:22.123Z",
                    "updated_at": "2019-08-24T14:15:22.123Z",
                    "deleted_at": "2019-08-24T14:15:22.123Z",
                    "currency_code": "usd",
                    "currency": {
                        "symbol": "$",
                        "symbol_native": "$",
                        "name": "US Dollar",
                        "includes_tax": false,
                        "code": "usd"
                    }
                }
            ],
            "options": [
                {
                    "id": "optval_01F0YESHR7S6ECD03RF6W12DSJ",
                    "value": "large",
                    "option_id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
                    "option": {},
                    "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                    "variant": {},
                    "created_at": "2019-08-24T14:15:22.123Z",
                    "updated_at": "2019-08-24T14:15:22.123Z",
                    "deleted_at": "2019-08-24T14:15:22.123Z",
                    "metadata": {
                        "car": "white"
                    }
                }
            ],
            "original_price": 0,
            "calculated_price": 0,
            "original_price_incl_tax": 0,
            "calculated_price_incl_tax": 0,
            "original_tax": 0,
            "calculated_tax": 0,
            "tax_rates": [
                {
                    "rate": 0,
                    "name": "string",
                    "code": "string"
                }
            ]
        }
    ],
    "options": [
        {
            "id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
            "title": "Size",
            "product_id": "prod_01G1G5V2MBA328390B5AXJ610F",
            "product": {},
            "created_at": "2019-08-24T14:15:22.123Z",
            "updated_at": "2019-08-24T14:15:22.123Z",
            "deleted_at": "2019-08-24T14:15:22.123Z",
            "metadata": {
                "car": "white"
            },
            "values": [
                {
                    "id": "optval_01F0YESHR7S6ECD03RF6W12DSJ",
                    "value": "large",
                    "option_id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
                    "option": {},
                    "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                    "variant": {},
                    "created_at": "2019-08-24T14:15:22.123Z",
                    "updated_at": "2019-08-24T14:15:22.123Z",
                    "deleted_at": "2019-08-24T14:15:22.123Z",
                    "metadata": {
                        "car": "white"
                    }
                }
            ]
        }
    ],
    "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"
        }
    },
    "profiles": [
        {
            "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