Magento B2B API
  1. orders/{id}
Magento B2B API
  • categories/{categoryId}
    • categories/{categoryId}
      DELETE
    • categories/{categoryId}
      GET
  • store/storeGroups
    • store/storeGroups
      GET
  • categories/{categoryId}/move
    • categories/{categoryId}/move
      PUT
  • store/storeViews
    • store/storeViews
      GET
  • categories/{categoryId}/products
    • categories/{categoryId}/products
      GET
    • categories/{categoryId}/products
      POST
    • categories/{categoryId}/products
      PUT
  • store/websites
    • store/websites
      GET
  • categories/{categoryId}/products/{sku}
    • categories/{categoryId}/products/{sku}
      DELETE
  • taxClasses
    • {classId}
    • {taxClassId}
    • search
    • taxClasses
      POST
  • categories/{id}
    • categories/{id}
      PUT
  • taxClasses/search
    • taxClasses/search
      GET
  • cmsBlock
    • {blockId}
    • {id}
    • search
    • cmsBlock
      POST
  • taxClasses/{classId}
    • taxClasses/{classId}
  • cmsBlock/search
    • cmsBlock/search
  • taxClasses/{taxClassId}
    • taxClasses/{taxClassId}
    • taxClasses/{taxClassId}
  • cmsBlock/{blockId}
    • cmsBlock/{blockId}
    • cmsBlock/{blockId}
  • taxRates
    • {rateId}
    • search
    • taxRates
    • taxRates
  • cmsBlock/{id}
    • cmsBlock/{id}
  • taxRates/search
    • taxRates/search
  • cmsPage
    • {id}
    • {pageId}
    • search
    • cmsPage
  • taxRates/{rateId}
    • taxRates/{rateId}
    • taxRates/{rateId}
  • cmsPage/search
    • cmsPage/search
  • taxRules
    • {ruleId}
    • search
    • taxRules
    • taxRules
  • cmsPage/{id}
    • cmsPage/{id}
  • taxRules/search
    • taxRules/search
  • cmsPage/{pageId}
    • cmsPage/{pageId}
    • cmsPage/{pageId}
  • taxRules/{ruleId}
    • taxRules/{ruleId}
    • taxRules/{ruleId}
  • company/
    • company/
    • company/
  • team/
    • team/
  • company/assignRoles
    • company/assignRoles
  • team/{companyId}
    • team/{companyId}
  • company/role/
    • company/role/
    • company/role/
  • team/{teamId}
    • team/{teamId}
    • team/{teamId}
    • team/{teamId}
  • company/role/{id}
    • company/role/{id}
  • temando/rma/{rmaId}/shipments
    • temando/rma/{rmaId}/shipments
  • company/role/{roleId}
    • company/role/{roleId}
    • company/role/{roleId}
  • transactions
    • {id}
    • transactions
  • addresses
    • {addressId}
  • company/role/{roleId}/users
    • company/role/{roleId}/users
  • transactions/{id}
    • transactions/{id}
  • company/{companyId}
    • company/{companyId}
    • company/{companyId}
    • company/{companyId}
  • worldpay-guest-carts/{cartId}/payment-information
    • worldpay-guest-carts/{cartId}/payment-information
  • companyCredits/
    • companyCredits/
  • companyCredits/company/{companyId}
    • companyCredits/company/{companyId}
  • companyCredits/history
    • companyCredits/history
  • companyCredits/history/{historyId}
    • companyCredits/history/{historyId}
  • companyCredits/{creditId}
    • companyCredits/{creditId}
  • companyCredits/{creditId}/decreaseBalance
    • companyCredits/{creditId}/decreaseBalance
  • companyCredits/{creditId}/increaseBalance
    • companyCredits/{creditId}/increaseBalance
  • companyCredits/{id}
    • companyCredits/{id}
  • configurable-products/variation
    • configurable-products/variation
  • configurable-products/{sku}/child
    • configurable-products/{sku}/child
  • configurable-products/{sku}/children
    • configurable-products/{sku}/children
  • configurable-products/{sku}/children/{childSku}
    • configurable-products/{sku}/children/{childSku}
  • configurable-products/{sku}/options
    • configurable-products/{sku}/options
  • configurable-products/{sku}/options/all
    • configurable-products/{sku}/options/all
  • configurable-products/{sku}/options/{id}
    • configurable-products/{sku}/options/{id}
    • configurable-products/{sku}/options/{id}
    • configurable-products/{sku}/options/{id}
  • coupons
    • {couponId}
    • deleteByCodes
    • deleteByIds
    • generate
    • search
    • coupons
  • coupons/deleteByCodes
    • coupons/deleteByCodes
  • coupons/deleteByIds
    • coupons/deleteByIds
  • coupons/generate
    • coupons/generate
  • coupons/search
    • coupons/search
  • coupons/{couponId}
    • coupons/{couponId}
    • coupons/{couponId}
    • coupons/{couponId}
  • creditmemo
    • {id}
      • comments
      • emails
    • refund
    • creditmemo
  • creditmemo/refund
    • creditmemo/refund
  • creditmemo/{id}
    • creditmemo/{id}
    • creditmemo/{id}
  • creditmemo/{id}/comments
    • creditmemo/{id}/comments
    • creditmemo/{id}/comments
  • creditmemo/{id}/emails
    • creditmemo/{id}/emails
  • creditmemos
    • creditmemos
  • customerGroups
    • {id}
      • permissions
    • default
      • {id}
      • {storeId}
    • search
    • customerGroups
  • customerGroups/default
    • customerGroups/default
  • customerGroups/default/{id}
    • customerGroups/default/{id}
  • customerGroups/default/{storeId}
    • customerGroups/default/{storeId}
  • customerGroups/search
    • customerGroups/search
  • customerGroups/{id}
    • customerGroups/{id}
    • customerGroups/{id}
    • customerGroups/{id}
  • customerGroups/{id}/permissions
    • customerGroups/{id}/permissions
  • customers
    • {customerId}
      • billingAddress
      • carts
      • confirm
      • shippingAddress
      • password
        • resetLinkToken
          • {resetPasswordLinkToken}
      • permissions
        • readonly
    • confirm
    • isEmailAvailable
    • me
      • activate
      • billingAddress
      • password
      • shippingAddress
    • password
    • resetPassword
    • search
    • validate
    • addresses
      • {addressId}
    • {email}
      • activate
    • customers
  • customers/addresses/{addressId}
    • customers/addresses/{addressId}
  • customers/confirm
    • customers/confirm
  • customers/isEmailAvailable
    • customers/isEmailAvailable
  • customers/me
    • customers/me
    • customers/me
  • customers/me/activate
    • customers/me/activate
  • customers/me/billingAddress
    • customers/me/billingAddress
  • customers/me/password
    • customers/me/password
  • customers/me/shippingAddress
    • customers/me/shippingAddress
  • customers/password
    • customers/password
  • customers/resetPassword
    • customers/resetPassword
  • customers/search
    • customers/search
  • customers/validate
    • customers/validate
  • customers/{customerId}
    • customers/{customerId}
    • customers/{customerId}
    • customers/{customerId}
  • customers/{customerId}/billingAddress
    • customers/{customerId}/billingAddress
  • customers/{customerId}/carts
    • customers/{customerId}/carts
  • customers/{customerId}/confirm
    • customers/{customerId}/confirm
  • customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
    • customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
  • customers/{customerId}/permissions/readonly
    • customers/{customerId}/permissions/readonly
  • customers/{customerId}/shippingAddress
    • customers/{customerId}/shippingAddress
  • customers/{email}/activate
    • customers/{email}/activate
  • directory/countries
    • directory/countries
  • directory/countries/{countryId}
    • directory/countries/{countryId}
  • directory/currency
    • directory/currency
  • eav/attribute-sets
    • eav/attribute-sets
  • eav/attribute-sets/list
    • eav/attribute-sets/list
  • eav/attribute-sets/{attributeSetId}
    • eav/attribute-sets/{attributeSetId}
    • eav/attribute-sets/{attributeSetId}
    • eav/attribute-sets/{attributeSetId}
  • gift-wrappings
    • {id}
    • {wrappingId}
    • gift-wrappings
    • gift-wrappings
  • gift-wrappings/{id}
    • gift-wrappings/{id}
    • gift-wrappings/{id}
  • gift-wrappings/{wrappingId}
    • gift-wrappings/{wrappingId}
  • giftregistry/mine/estimate-shipping-methods
    • giftregistry/mine/estimate-shipping-methods
  • guest-carts
    • {cartId}
      • billing-address
      • checkout-fields
      • collect-totals
      • coupons
        • {couponCode}
      • delivery-option
      • estimate-shipping-methods
      • gift-message
        • {itemId}
      • items
        • {itemId}
      • order
      • payment-information
      • payment-methods
      • selected-payment-method
      • set-payment-information
      • shipping-information
      • shipping-methods
      • totals
      • totals-information
      • collection-point
        • search-request
        • search-result
        • select
    • guest-carts
  • guest-carts/{cartId}
    • guest-carts/{cartId}
    • guest-carts/{cartId}
  • guest-carts/{cartId}/billing-address
    • guest-carts/{cartId}/billing-address
    • guest-carts/{cartId}/billing-address
  • guest-carts/{cartId}/checkout-fields
    • guest-carts/{cartId}/checkout-fields
  • guest-carts/{cartId}/collect-totals
    • guest-carts/{cartId}/collect-totals
  • guest-carts/{cartId}/collection-point/search-request
    • guest-carts/{cartId}/collection-point/search-request
    • guest-carts/{cartId}/collection-point/search-request
  • guest-carts/{cartId}/collection-point/search-result
    • guest-carts/{cartId}/collection-point/search-result
  • guest-carts/{cartId}/collection-point/select
    • guest-carts/{cartId}/collection-point/select
  • guest-carts/{cartId}/coupons
    • guest-carts/{cartId}/coupons
    • guest-carts/{cartId}/coupons
  • guest-carts/{cartId}/coupons/{couponCode}
    • guest-carts/{cartId}/coupons/{couponCode}
  • guest-carts/{cartId}/delivery-option
    • guest-carts/{cartId}/delivery-option
  • guest-carts/{cartId}/estimate-shipping-methods
    • guest-carts/{cartId}/estimate-shipping-methods
  • guest-carts/{cartId}/gift-message
    • guest-carts/{cartId}/gift-message
    • guest-carts/{cartId}/gift-message
  • guest-carts/{cartId}/gift-message/{itemId}
    • guest-carts/{cartId}/gift-message/{itemId}
    • guest-carts/{cartId}/gift-message/{itemId}
  • guest-carts/{cartId}/items
    • guest-carts/{cartId}/items
    • guest-carts/{cartId}/items
  • guest-carts/{cartId}/items/{itemId}
    • guest-carts/{cartId}/items/{itemId}
    • guest-carts/{cartId}/items/{itemId}
  • guest-carts/{cartId}/order
    • guest-carts/{cartId}/order
  • guest-carts/{cartId}/payment-information
    • guest-carts/{cartId}/payment-information
    • guest-carts/{cartId}/payment-information
  • guest-carts/{cartId}/payment-methods
    • guest-carts/{cartId}/payment-methods
  • guest-carts/{cartId}/selected-payment-method
    • guest-carts/{cartId}/selected-payment-method
    • guest-carts/{cartId}/selected-payment-method
  • guest-carts/{cartId}/set-payment-information
    • guest-carts/{cartId}/set-payment-information
  • guest-carts/{cartId}/shipping-information
    • guest-carts/{cartId}/shipping-information
  • guest-carts/{cartId}/shipping-methods
    • guest-carts/{cartId}/shipping-methods
  • guest-carts/{cartId}/totals
    • guest-carts/{cartId}/totals
  • guest-carts/{cartId}/totals-information
    • guest-carts/{cartId}/totals-information
  • guest-giftregistry/{cartId}/estimate-shipping-methods
    • guest-giftregistry/{cartId}/estimate-shipping-methods
  • hierarchy/move/{id}
    • hierarchy/move/{id}
  • hierarchy/{id}
    • hierarchy/{id}
  • integration/admin/token
    • integration/admin/token
  • integration/customer/token
    • integration/customer/token
  • invoice/{invoiceId}/refund
    • invoice/{invoiceId}/refund
  • invoices
    • 默认分组
    • {id}
      • capture
      • comments
      • emails
      • void
    • comments
    • 默认目录
    • invoices
  • invoices/
    • invoices/
  • invoices/comments
    • invoices/comments
  • invoices/{id}
    • invoices/{id}
  • invoices/{id}/capture
    • invoices/{id}/capture
  • invoices/{id}/comments
    • invoices/{id}/comments
  • invoices/{id}/emails
    • invoices/{id}/emails
  • invoices/{id}/void
    • invoices/{id}/void
  • modules
    • modules
  • negotiable-carts/{cartId}/billing-address
    • negotiable-carts/{cartId}/billing-address
    • negotiable-carts/{cartId}/billing-address
  • negotiable-carts/{cartId}/coupons
    • negotiable-carts/{cartId}/coupons
  • negotiable-carts/{cartId}/coupons/{couponCode}
    • negotiable-carts/{cartId}/coupons/{couponCode}
  • negotiable-carts/{cartId}/estimate-shipping-methods
    • negotiable-carts/{cartId}/estimate-shipping-methods
  • negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id
    • negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id
  • negotiable-carts/{cartId}/giftCards
    • negotiable-carts/{cartId}/giftCards
  • negotiable-carts/{cartId}/giftCards/{giftCardCode}
    • negotiable-carts/{cartId}/giftCards/{giftCardCode}
  • negotiable-carts/{cartId}/payment-information
    • negotiable-carts/{cartId}/payment-information
    • negotiable-carts/{cartId}/payment-information
  • negotiable-carts/{cartId}/set-payment-information
    • negotiable-carts/{cartId}/set-payment-information
  • negotiable-carts/{cartId}/shipping-information
    • negotiable-carts/{cartId}/shipping-information
  • negotiable-carts/{cartId}/totals
    • negotiable-carts/{cartId}/totals
  • negotiableQuote/attachmentContent
    • negotiableQuote/attachmentContent
  • negotiableQuote/decline
    • negotiableQuote/decline
  • negotiableQuote/pricesUpdated
    • negotiableQuote/pricesUpdated
  • negotiableQuote/request
    • negotiableQuote/request
  • negotiableQuote/submitToCustomer
    • negotiableQuote/submitToCustomer
  • negotiableQuote/{quoteId}
    • negotiableQuote/{quoteId}
  • negotiableQuote/{quoteId}/comments
    • negotiableQuote/{quoteId}/comments
  • negotiableQuote/{quoteId}/shippingMethod
    • negotiableQuote/{quoteId}/shippingMethod
  • order/{orderId}/invoice
    • order/{orderId}/invoice
  • order/{orderId}/refund
    • order/{orderId}/refund
  • order/{orderId}/ship
    • order/{orderId}/ship
  • orders
    • 默认分组
    • {id}
      • cancel
      • comments
      • emails
      • hold
      • statuses
      • unhold
    • {parent_id}
    • create
    • items
      • {id}
    • 默认目录
    • orders
  • orders/
    • orders/
  • orders/create
    • orders/create
  • orders/items
    • orders/items
  • orders/items/{id}
    • orders/items/{id}
  • orders/{id}
    • orders/{id}
      GET
  • orders/{id}/cancel
    • orders/{id}/cancel
  • orders/{id}/comments
    • orders/{id}/comments
    • orders/{id}/comments
  • orders/{id}/emails
    • orders/{id}/emails
  • orders/{id}/hold
    • orders/{id}/hold
  • orders/{id}/statuses
    • orders/{id}/statuses
  • orders/{id}/unhold
    • orders/{id}/unhold
  • orders/{parent_id}
    • orders/{parent_id}
  • products
    • {sku}
      • downloadable-links
        • {id}
        • samples
          • {id}
      • links
        • {type}
          • {linkedProductSku}
      • media
        • {entryId}
      • options
        • {optionId}
      • websites
        • {websiteId}
      • group-prices
        • {customerGroupId}
          • tiers
            • {qty}
              • price
                • {price}
    • attribute-sets
      • {attributeSetId}
        • attributes
          • {attributeCode}
        • groups
      • attributes
      • groups
        • {groupId}
        • list
      • sets
        • list
    • attributes
      • {attributeCode}
        • options
          • {optionId}
      • types
    • base-prices
    • base-prices-information
    • cost
    • cost-delete
    • cost-information
    • options
      • {optionId}
      • types
    • special-price
    • special-price-delete
    • special-price-information
    • tier-prices
    • tier-prices-delete
    • tier-prices-information
    • types
    • downloadable-links
      • samples
        • {id}
      • {id}
    • links
      • types
      • {type}
        • attributes
    • media
      • types
        • {attributeSetName}
    • {productSku}
      • stockItems
        • {itemId}
    • products
    • products
  • products-render-info
    • products-render-info
  • products/attribute-sets
    • products/attribute-sets
  • products/attribute-sets/attributes
    • products/attribute-sets/attributes
  • products/attribute-sets/groups
    • products/attribute-sets/groups
  • products/attribute-sets/groups/list
    • products/attribute-sets/groups/list
  • products/attribute-sets/groups/{groupId}
    • products/attribute-sets/groups/{groupId}
  • products/attribute-sets/sets/list
    • products/attribute-sets/sets/list
  • products/attribute-sets/{attributeSetId}
    • products/attribute-sets/{attributeSetId}
    • products/attribute-sets/{attributeSetId}
    • products/attribute-sets/{attributeSetId}
  • addresses/{addressId}
    • addresses/{addressId}
  • products/attribute-sets/{attributeSetId}/attributes
    • products/attribute-sets/{attributeSetId}/attributes
  • amazon-billing-address/{amazonOrderReferenceId}
    • amazon-billing-address/{amazonOrderReferenceId}
  • products/attribute-sets/{attributeSetId}/attributes/{attributeCode}
    • products/attribute-sets/{attributeSetId}/attributes/{attributeCode}
  • amazon-shipping-address/{amazonOrderReferenceId}
    • amazon-shipping-address/{amazonOrderReferenceId}
  • products/attribute-sets/{attributeSetId}/groups
    • products/attribute-sets/{attributeSetId}/groups
  • amazon/order-ref
    • amazon/order-ref
  • products/attributes
    • products/attributes
    • products/attributes
  • analytics/link
    • analytics/link
  • products/attributes/types
    • products/attributes/types
  • attributeMetadata/customer
    • attributeMetadata/customer
  • products/attributes/{attributeCode}
    • products/attributes/{attributeCode}
    • products/attributes/{attributeCode}
    • products/attributes/{attributeCode}
  • attributeMetadata/customer/attribute/{attributeCode}
    • attributeMetadata/customer/attribute/{attributeCode}
  • products/attributes/{attributeCode}/options
    • products/attributes/{attributeCode}/options
    • products/attributes/{attributeCode}/options
  • attributeMetadata/customer/custom
    • attributeMetadata/customer/custom
  • products/attributes/{attributeCode}/options/{optionId}
    • products/attributes/{attributeCode}/options/{optionId}
  • attributeMetadata/customer/form/{formCode}
    • attributeMetadata/customer/form/{formCode}
  • products/base-prices
    • products/base-prices
  • attributeMetadata/customerAddress
    • attributeMetadata/customerAddress
  • products/base-prices-information
    • products/base-prices-information
  • attributeMetadata/customerAddress/attribute/{attributeCode}
    • attributeMetadata/customerAddress/attribute/{attributeCode}
  • products/cost
    • products/cost
  • attributeMetadata/customerAddress/custom
    • attributeMetadata/customerAddress/custom
  • products/cost-delete
    • products/cost-delete
  • attributeMetadata/customerAddress/form/{formCode}
    • attributeMetadata/customerAddress/form/{formCode}
  • products/cost-information
    • products/cost-information
  • bulk/{bulkUuid}/detailed-status
    • bulk/{bulkUuid}/detailed-status
  • products/downloadable-links/samples/{id}
    • products/downloadable-links/samples/{id}
  • bulk/{bulkUuid}/operation-status/{status}
    • bulk/{bulkUuid}/operation-status/{status}
  • products/downloadable-links/{id}
    • products/downloadable-links/{id}
  • bulk/{bulkUuid}/status
    • bulk/{bulkUuid}/status
  • products/links/types
    • products/links/types
  • bundle-products/options/add
    • bundle-products/options/add
  • products/links/{type}/attributes
    • products/links/{type}/attributes
  • bundle-products/options/types
    • bundle-products/options/types
  • products/media/types/{attributeSetName}
    • products/media/types/{attributeSetName}
  • bundle-products/options/{optionId}
    • bundle-products/options/{optionId}
  • products/options
    • products/options
  • bundle-products/{productSku}/children
    • bundle-products/{productSku}/children
  • products/options/types
    • products/options/types
  • bundle-products/{sku}/links/{id}
    • bundle-products/{sku}/links/{id}
  • products/options/{optionId}
    • products/options/{optionId}
  • bundle-products/{sku}/links/{optionId}
    • bundle-products/{sku}/links/{optionId}
  • products/special-price
    • products/special-price
  • bundle-products/{sku}/options/all
    • bundle-products/{sku}/options/all
  • products/special-price-delete
    • products/special-price-delete
  • bundle-products/{sku}/options/{optionId}
    • bundle-products/{sku}/options/{optionId}
    • bundle-products/{sku}/options/{optionId}
  • products/special-price-information
    • products/special-price-information
  • bundle-products/{sku}/options/{optionId}/children/{childSku}
    • bundle-products/{sku}/options/{optionId}/children/{childSku}
  • products/tier-prices
    • products/tier-prices
    • products/tier-prices
  • carts/
    • carts/
  • products/tier-prices-delete
    • products/tier-prices-delete
  • carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
    • carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
  • products/tier-prices-information
    • products/tier-prices-information
  • carts/guest-carts/{cartId}/giftCards
    • carts/guest-carts/{cartId}/giftCards
  • products/types
    • products/types
  • carts/guest-carts/{cartId}/giftCards/{giftCardCode}
    • carts/guest-carts/{cartId}/giftCards/{giftCardCode}
  • products/{productSku}/stockItems/{itemId}
    • products/{productSku}/stockItems/{itemId}
  • carts/licence
    • carts/licence
  • products/{sku}
    • products/{sku}
    • products/{sku}
    • products/{sku}
  • carts/mine
    • carts/mine
    • carts/mine
    • carts/mine
  • products/{sku}/downloadable-links
    • products/{sku}/downloadable-links
    • products/{sku}/downloadable-links
  • carts/mine/balance/apply
    • carts/mine/balance/apply
  • products/{sku}/downloadable-links/samples
    • products/{sku}/downloadable-links/samples
    • products/{sku}/downloadable-links/samples
  • carts/mine/balance/unapply
    • carts/mine/balance/unapply
  • products/{sku}/downloadable-links/samples/{id}
    • products/{sku}/downloadable-links/samples/{id}
  • carts/mine/billing-address
    • carts/mine/billing-address
    • carts/mine/billing-address
  • products/{sku}/downloadable-links/{id}
    • products/{sku}/downloadable-links/{id}
  • carts/mine/checkGiftCard/{giftCardCode}
    • carts/mine/checkGiftCard/{giftCardCode}
  • products/{sku}/group-prices/{customerGroupId}/tiers
    • products/{sku}/group-prices/{customerGroupId}/tiers
  • carts/mine/checkout-fields
    • carts/mine/checkout-fields
  • products/{sku}/group-prices/{customerGroupId}/tiers/{qty}
    • products/{sku}/group-prices/{customerGroupId}/tiers/{qty}
  • carts/mine/collect-totals
    • carts/mine/collect-totals
  • products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}
    • products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}
  • carts/mine/collection-point/search-request
    • carts/mine/collection-point/search-request
    • carts/mine/collection-point/search-request
  • products/{sku}/links
    • products/{sku}/links
    • products/{sku}/links
  • carts/mine/collection-point/search-result
    • carts/mine/collection-point/search-result
  • products/{sku}/links/{type}
    • products/{sku}/links/{type}
  • carts/mine/collection-point/select
    • carts/mine/collection-point/select
  • products/{sku}/links/{type}/{linkedProductSku}
    • products/{sku}/links/{type}/{linkedProductSku}
  • carts/mine/coupons
    • carts/mine/coupons
    • carts/mine/coupons
  • products/{sku}/media
    • products/{sku}/media
    • products/{sku}/media
  • carts/mine/coupons/{couponCode}
    • carts/mine/coupons/{couponCode}
  • products/{sku}/media/{entryId}
    • products/{sku}/media/{entryId}
    • products/{sku}/media/{entryId}
    • products/{sku}/media/{entryId}
  • carts/mine/delivery-option
    • carts/mine/delivery-option
  • products/{sku}/options
    • products/{sku}/options
  • carts/mine/estimate-shipping-methods
    • carts/mine/estimate-shipping-methods
  • products/{sku}/options/{optionId}
    • products/{sku}/options/{optionId}
    • products/{sku}/options/{optionId}
  • carts/mine/estimate-shipping-methods-by-address-id
    • carts/mine/estimate-shipping-methods-by-address-id
  • products/{sku}/websites
    • products/{sku}/websites
    • products/{sku}/websites
  • carts/mine/gift-message
    • carts/mine/gift-message
    • carts/mine/gift-message
  • products/{sku}/websites/{websiteId}
    • products/{sku}/websites/{websiteId}
  • carts/mine/gift-message/{itemId}
    • carts/mine/gift-message/{itemId}
    • carts/mine/gift-message/{itemId}
  • requisition_lists
    • requisition_lists
  • carts/mine/giftCards
    • carts/mine/giftCards
  • returns
    • {id}
      • comments
      • labels
      • tracking-numbers
        • {trackId}
    • returns
    • returns
  • carts/mine/giftCards/{giftCardCode}
    • carts/mine/giftCards/{giftCardCode}
  • returns/{id}
    • returns/{id}
    • returns/{id}
    • returns/{id}
  • carts/mine/items
    • carts/mine/items
    • carts/mine/items
  • returns/{id}/comments
    • returns/{id}/comments
    • returns/{id}/comments
  • carts/mine/items/{itemId}
    • carts/mine/items/{itemId}
    • carts/mine/items/{itemId}
  • returns/{id}/labels
    • returns/{id}/labels
  • carts/mine/order
    • carts/mine/order
  • returns/{id}/tracking-numbers
    • returns/{id}/tracking-numbers
    • returns/{id}/tracking-numbers
  • carts/mine/payment-information
    • carts/mine/payment-information
    • carts/mine/payment-information
  • returns/{id}/tracking-numbers/{trackId}
    • returns/{id}/tracking-numbers/{trackId}
  • carts/mine/payment-methods
    • carts/mine/payment-methods
  • returnsAttributeMetadata
    • {attributeCode}
    • custom
    • form
      • {formCode}
    • returnsAttributeMetadata
  • carts/mine/selected-payment-method
    • carts/mine/selected-payment-method
    • carts/mine/selected-payment-method
  • returnsAttributeMetadata/custom
    • returnsAttributeMetadata/custom
  • carts/mine/set-payment-information
    • carts/mine/set-payment-information
  • returnsAttributeMetadata/form/{formCode}
    • returnsAttributeMetadata/form/{formCode}
  • carts/mine/shipping-information
    • carts/mine/shipping-information
  • returnsAttributeMetadata/{attributeCode}
    • returnsAttributeMetadata/{attributeCode}
  • carts/mine/shipping-methods
    • carts/mine/shipping-methods
  • reward/mine/use-reward
    • reward/mine/use-reward
  • carts/mine/totals
    • carts/mine/totals
  • salesRules
    • {ruleId}
    • search
    • salesRules
  • carts/mine/totals-information
    • carts/mine/totals-information
  • salesRules/search
    • salesRules/search
  • carts/search
    • carts/search
  • salesRules/{ruleId}
    • salesRules/{ruleId}
    • salesRules/{ruleId}
    • salesRules/{ruleId}
  • carts/{cartId}
    • carts/{cartId}
    • carts/{cartId}
  • search
    • search
  • carts/{cartId}/billing-address
    • carts/{cartId}/billing-address
    • carts/{cartId}/billing-address
  • sharedCatalog
    • 默认分组
    • {id}
      • assignCategories
      • assignProducts
      • categories
      • products
      • unassignCategories
      • unassignProducts
    • {sharedCatalogId}
      • assignCompanies
      • companies
      • unassignCompanies
    • 默认目录
    • sharedCatalog
  • carts/{cartId}/coupons
    • carts/{cartId}/coupons
    • carts/{cartId}/coupons
  • sharedCatalog/
    • sharedCatalog/
  • carts/{cartId}/coupons/{couponCode}
    • carts/{cartId}/coupons/{couponCode}
  • sharedCatalog/{id}
    • sharedCatalog/{id}
  • carts/{cartId}/estimate-shipping-methods
    • carts/{cartId}/estimate-shipping-methods
  • sharedCatalog/{id}/assignCategories
    • sharedCatalog/{id}/assignCategories
  • carts/{cartId}/estimate-shipping-methods-by-address-id
    • carts/{cartId}/estimate-shipping-methods-by-address-id
  • sharedCatalog/{id}/assignProducts
    • sharedCatalog/{id}/assignProducts
  • carts/{cartId}/gift-message
    • carts/{cartId}/gift-message
    • carts/{cartId}/gift-message
  • sharedCatalog/{id}/categories
    • sharedCatalog/{id}/categories
  • carts/{cartId}/gift-message/{itemId}
    • carts/{cartId}/gift-message/{itemId}
    • carts/{cartId}/gift-message/{itemId}
  • sharedCatalog/{id}/products
    • sharedCatalog/{id}/products
  • carts/{cartId}/giftCards
    • carts/{cartId}/giftCards
  • sharedCatalog/{id}/unassignCategories
    • sharedCatalog/{id}/unassignCategories
  • carts/{cartId}/giftCards/{giftCardCode}
    • carts/{cartId}/giftCards/{giftCardCode}
  • sharedCatalog/{id}/unassignProducts
    • sharedCatalog/{id}/unassignProducts
  • carts/{cartId}/items
    • carts/{cartId}/items
  • sharedCatalog/{sharedCatalogId}
    • sharedCatalog/{sharedCatalogId}
    • sharedCatalog/{sharedCatalogId}
  • carts/{cartId}/items/{itemId}
    • carts/{cartId}/items/{itemId}
    • carts/{cartId}/items/{itemId}
  • sharedCatalog/{sharedCatalogId}/assignCompanies
    • sharedCatalog/{sharedCatalogId}/assignCompanies
  • carts/{cartId}/order
    • carts/{cartId}/order
  • sharedCatalog/{sharedCatalogId}/companies
    • sharedCatalog/{sharedCatalogId}/companies
  • carts/{cartId}/payment-methods
    • carts/{cartId}/payment-methods
  • sharedCatalog/{sharedCatalogId}/unassignCompanies
    • sharedCatalog/{sharedCatalogId}/unassignCompanies
  • carts/{cartId}/selected-payment-method
    • carts/{cartId}/selected-payment-method
    • carts/{cartId}/selected-payment-method
  • shipment/
    • shipment/
  • carts/{cartId}/shipping-information
    • carts/{cartId}/shipping-information
  • shipment/track
    • shipment/track
  • carts/{cartId}/shipping-methods
    • carts/{cartId}/shipping-methods
  • shipment/track/{id}
    • shipment/track/{id}
  • carts/{cartId}/totals
    • carts/{cartId}/totals
  • shipment/{id}
    • shipment/{id}
  • carts/{cartId}/totals-information
    • carts/{cartId}/totals-information
  • shipment/{id}/comments
    • shipment/{id}/comments
    • shipment/{id}/comments
  • carts/{quoteId}/giftCards
    • carts/{quoteId}/giftCards
  • shipment/{id}/emails
    • shipment/{id}/emails
  • carts/{quoteId}/items
    • carts/{quoteId}/items
  • shipment/{id}/label
    • shipment/{id}/label
  • categories
    • {categoryId}
      • move
      • products
        • {sku}
    • {id}
    • attributes
      • {attributeCode}
        • options
    • list
    • categories
    • categories
  • shipments
    • shipments
  • categories/attributes
    • categories/attributes
  • stockItems/lowStock/
    • stockItems/lowStock/
  • categories/attributes/{attributeCode}
    • categories/attributes/{attributeCode}
  • stockItems/{productSku}
    • stockItems/{productSku}
  • categories/attributes/{attributeCode}/options
    • categories/attributes/{attributeCode}/options
  • stockStatuses/{productSku}
    • stockStatuses/{productSku}
  • categories/list
    • categories/list
  • store/storeConfigs
    • store/storeConfigs
  • amazon-billing-address
    • {amazonOrderReferenceId}
  • amazon-shipping-address
    • {amazonOrderReferenceId}
  • amazon
    • order-ref
  • analytics
    • link
  • attributeMetadata
    • customer
      • attribute
        • {attributeCode}
      • custom
      • form
        • {formCode}
    • customerAddress
      • attribute
        • {attributeCode}
      • custom
      • form
        • {formCode}
  • bulk
    • {bulkUuid}
      • detailed-status
      • operation-status
        • {status}
      • status
  • bundle-products
    • options
      • add
      • types
      • {optionId}
    • {productSku}
      • children
    • {sku}
      • links
        • {id}
        • {optionId}
      • options
        • all
        • {optionId}
          • children
            • {childSku}
  • carts
    • 默认分组
    • guest-carts
      • {cartId}
        • checkGiftCard
          • {giftCardCode}
        • giftCards
          • {giftCardCode}
    • licence
    • mine
      • balance
        • apply
        • unapply
      • billing-address
      • checkGiftCard
        • {giftCardCode}
      • checkout-fields
      • collect-totals
      • collection-point
        • search-request
        • search-result
        • select
      • coupons
        • {couponCode}
      • delivery-option
      • estimate-shipping-methods
      • estimate-shipping-methods-by-address-id
      • gift-message
        • {itemId}
      • giftCards
        • {giftCardCode}
      • items
        • {itemId}
      • order
      • payment-information
      • payment-methods
      • selected-payment-method
      • set-payment-information
      • shipping-information
      • shipping-methods
      • totals
      • totals-information
    • search
    • {cartId}
      • billing-address
      • coupons
        • {couponCode}
      • estimate-shipping-methods
      • estimate-shipping-methods-by-address-id
      • gift-message
        • {itemId}
      • giftCards
        • {giftCardCode}
      • items
        • {itemId}
      • order
      • payment-methods
      • selected-payment-method
      • shipping-information
      • shipping-methods
      • totals
      • totals-information
    • {quoteId}
      • giftCards
      • items
    • 默认目录
  • company
    • 默认分组
    • assignRoles
    • role
      • 默认分组
      • {id}
      • {roleId}
        • users
      • 默认目录
    • {companyId}
    • 默认目录
  • companyCredits
    • 默认分组
    • company
      • {companyId}
    • history
      • {historyId}
    • {creditId}
      • decreaseBalance
      • increaseBalance
    • {id}
    • 默认目录
  • configurable-products
    • variation
    • {sku}
      • child
      • children
        • {childSku}
      • options
        • all
        • {id}
  • directory
    • countries
      • {countryId}
    • currency
  • eav
    • attribute-sets
      • list
      • {attributeSetId}
  • giftregistry
    • mine
      • estimate-shipping-methods
  • guest-giftregistry
    • {cartId}
      • estimate-shipping-methods
  • hierarchy
    • move
      • {id}
    • {id}
  • integration
    • admin
      • token
    • customer
      • token
  • invoice
    • {invoiceId}
      • refund
  • negotiable-carts
    • {cartId}
      • billing-address
      • coupons
        • {couponCode}
      • estimate-shipping-methods
      • estimate-shipping-methods-by-address-id
      • giftCards
        • {giftCardCode}
      • payment-information
      • set-payment-information
      • shipping-information
      • totals
  • negotiableQuote
    • attachmentContent
    • decline
    • pricesUpdated
    • request
    • submitToCustomer
    • {quoteId}
      • comments
      • shippingMethod
  • order
    • {orderId}
      • invoice
      • refund
      • ship
  • reward
    • mine
      • use-reward
  • shipment
    • 默认分组
    • track
      • {id}
    • {id}
      • comments
      • emails
      • label
    • 默认目录
  • stockItems
    • lowStock
      • 默认分组
      • 默认目录
    • {productSku}
  • stockStatuses
    • {productSku}
  • store
    • storeConfigs
    • storeGroups
    • storeViews
    • websites
  • team
    • 默认分组
    • {companyId}
    • {teamId}
    • 默认目录
  • temando
    • rma
      • {rmaId}
        • shipments
  • worldpay-guest-carts
    • {cartId}
      • payment-information
  1. orders/{id}

orders/{id}

GET
/V1/orders/{id}
orders/{id}
Loads a specified order.
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'http:///V1/orders/'
响应示例响应示例
200 - 示例 1
{
    "adjustment_negative": 0,
    "adjustment_positive": 0,
    "applied_rule_ids": "string",
    "base_adjustment_negative": 0,
    "base_adjustment_positive": 0,
    "base_currency_code": "string",
    "base_discount_amount": 0,
    "base_discount_canceled": 0,
    "base_discount_invoiced": 0,
    "base_discount_refunded": 0,
    "base_discount_tax_compensation_amount": 0,
    "base_discount_tax_compensation_invoiced": 0,
    "base_discount_tax_compensation_refunded": 0,
    "base_grand_total": 0,
    "base_shipping_amount": 0,
    "base_shipping_canceled": 0,
    "base_shipping_discount_amount": 0,
    "base_shipping_discount_tax_compensation_amnt": 0,
    "base_shipping_incl_tax": 0,
    "base_shipping_invoiced": 0,
    "base_shipping_refunded": 0,
    "base_shipping_tax_amount": 0,
    "base_shipping_tax_refunded": 0,
    "base_subtotal": 0,
    "base_subtotal_canceled": 0,
    "base_subtotal_incl_tax": 0,
    "base_subtotal_invoiced": 0,
    "base_subtotal_refunded": 0,
    "base_tax_amount": 0,
    "base_tax_canceled": 0,
    "base_tax_invoiced": 0,
    "base_tax_refunded": 0,
    "base_to_global_rate": 0,
    "base_to_order_rate": 0,
    "base_total_canceled": 0,
    "base_total_due": 0,
    "base_total_invoiced": 0,
    "base_total_invoiced_cost": 0,
    "base_total_offline_refunded": 0,
    "base_total_online_refunded": 0,
    "base_total_paid": 0,
    "base_total_qty_ordered": 0,
    "base_total_refunded": 0,
    "billing_address": {
        "address_type": "string",
        "city": "string",
        "company": "string",
        "country_id": "string",
        "customer_address_id": 0,
        "customer_id": 0,
        "email": "string",
        "entity_id": 0,
        "extension_attributes": {
            "checkout_fields": [
                {
                    "attribute_code": "string",
                    "value": "string"
                }
            ]
        },
        "fax": "string",
        "firstname": "string",
        "lastname": "string",
        "middlename": "string",
        "parent_id": 0,
        "postcode": "string",
        "prefix": "string",
        "region": "string",
        "region_code": "string",
        "region_id": 0,
        "street": [
            "string"
        ],
        "suffix": "string",
        "telephone": "string",
        "vat_id": "string",
        "vat_is_valid": 0,
        "vat_request_date": "string",
        "vat_request_id": "string",
        "vat_request_success": 0
    },
    "billing_address_id": 0,
    "can_ship_partially": 0,
    "can_ship_partially_item": 0,
    "coupon_code": "string",
    "created_at": "string",
    "customer_dob": "string",
    "customer_email": "string",
    "customer_firstname": "string",
    "customer_gender": 0,
    "customer_group_id": 0,
    "customer_id": 0,
    "customer_is_guest": 0,
    "customer_lastname": "string",
    "customer_middlename": "string",
    "customer_note": "string",
    "customer_note_notify": 0,
    "customer_prefix": "string",
    "customer_suffix": "string",
    "customer_taxvat": "string",
    "discount_amount": 0,
    "discount_canceled": 0,
    "discount_description": "string",
    "discount_invoiced": 0,
    "discount_refunded": 0,
    "discount_tax_compensation_amount": 0,
    "discount_tax_compensation_invoiced": 0,
    "discount_tax_compensation_refunded": 0,
    "edit_increment": 0,
    "email_sent": 0,
    "entity_id": 0,
    "ext_customer_id": "string",
    "ext_order_id": "string",
    "extension_attributes": {
        "amazon_order_reference_id": "string",
        "applied_taxes": [
            {
                "amount": 0,
                "base_amount": 0,
                "code": "string",
                "extension_attributes": {
                    "rates": [
                        {
                            "code": "string",
                            "extension_attributes": {},
                            "percent": 0,
                            "title": "string"
                        }
                    ]
                },
                "percent": 0,
                "title": "string"
            }
        ],
        "base_customer_balance_amount": 0,
        "base_customer_balance_invoiced": 0,
        "base_customer_balance_refunded": 0,
        "base_customer_balance_total_refunded": 0,
        "base_gift_cards_amount": 0,
        "base_gift_cards_invoiced": 0,
        "base_gift_cards_refunded": 0,
        "base_reward_currency_amount": 0,
        "company_order_attributes": {
            "company_id": 0,
            "company_name": "string",
            "extension_attributes": {},
            "order_id": 0
        },
        "converting_from_quote": true,
        "customer_balance_amount": 0,
        "customer_balance_invoiced": 0,
        "customer_balance_refunded": 0,
        "customer_balance_total_refunded": 0,
        "gift_cards": [
            {
                "amount": 0,
                "base_amount": 0,
                "code": "string",
                "id": 0
            }
        ],
        "gift_cards_amount": 0,
        "gift_cards_invoiced": 0,
        "gift_cards_refunded": 0,
        "gift_message": {
            "customer_id": 0,
            "extension_attributes": {
                "entity_id": "string",
                "entity_type": "string",
                "wrapping_add_printed_card": true,
                "wrapping_allow_gift_receipt": true,
                "wrapping_id": 0
            },
            "gift_message_id": 0,
            "message": "string",
            "recipient": "string",
            "sender": "string"
        },
        "gw_add_card": "string",
        "gw_allow_gift_receipt": "string",
        "gw_base_price": "string",
        "gw_base_price_incl_tax": "string",
        "gw_base_price_invoiced": "string",
        "gw_base_price_refunded": "string",
        "gw_base_tax_amount": "string",
        "gw_base_tax_amount_invoiced": "string",
        "gw_base_tax_amount_refunded": "string",
        "gw_card_base_price": "string",
        "gw_card_base_price_incl_tax": "string",
        "gw_card_base_price_invoiced": "string",
        "gw_card_base_price_refunded": "string",
        "gw_card_base_tax_amount": "string",
        "gw_card_base_tax_invoiced": "string",
        "gw_card_base_tax_refunded": "string",
        "gw_card_price": "string",
        "gw_card_price_incl_tax": "string",
        "gw_card_price_invoiced": "string",
        "gw_card_price_refunded": "string",
        "gw_card_tax_amount": "string",
        "gw_card_tax_invoiced": "string",
        "gw_card_tax_refunded": "string",
        "gw_id": "string",
        "gw_items_base_price": "string",
        "gw_items_base_price_incl_tax": "string",
        "gw_items_base_price_invoiced": "string",
        "gw_items_base_price_refunded": "string",
        "gw_items_base_tax_amount": "string",
        "gw_items_base_tax_invoiced": "string",
        "gw_items_base_tax_refunded": "string",
        "gw_items_price": "string",
        "gw_items_price_incl_tax": "string",
        "gw_items_price_invoiced": "string",
        "gw_items_price_refunded": "string",
        "gw_items_tax_amount": "string",
        "gw_items_tax_invoiced": "string",
        "gw_items_tax_refunded": "string",
        "gw_price": "string",
        "gw_price_incl_tax": "string",
        "gw_price_invoiced": "string",
        "gw_price_refunded": "string",
        "gw_tax_amount": "string",
        "gw_tax_amount_invoiced": "string",
        "gw_tax_amount_refunded": "string",
        "item_applied_taxes": [
            {
                "applied_taxes": [
                    {
                        "amount": 0,
                        "base_amount": 0,
                        "code": "string",
                        "extension_attributes": {
                            "rates": [
                                {
                                    "code": "string",
                                    "extension_attributes": {},
                                    "percent": 0,
                                    "title": "string"
                                }
                            ]
                        },
                        "percent": 0,
                        "title": "string"
                    }
                ],
                "associated_item_id": 0,
                "extension_attributes": {},
                "item_id": 0,
                "type": "string"
            }
        ],
        "payment_additional_info": [
            {
                "key": "string",
                "value": "string"
            }
        ],
        "reward_currency_amount": 0,
        "reward_points_balance": 0,
        "shipping_assignments": [
            {
                "extension_attributes": {},
                "items": [
                    {
                        "additional_data": "string",
                        "amount_refunded": 0,
                        "applied_rule_ids": "string",
                        "base_amount_refunded": 0,
                        "base_cost": 0,
                        "base_discount_amount": 0,
                        "base_discount_invoiced": 0,
                        "base_discount_refunded": 0,
                        "base_discount_tax_compensation_amount": 0,
                        "base_discount_tax_compensation_invoiced": 0,
                        "base_discount_tax_compensation_refunded": 0,
                        "base_original_price": 0,
                        "base_price": 0,
                        "base_price_incl_tax": 0,
                        "base_row_invoiced": 0,
                        "base_row_total": 0,
                        "base_row_total_incl_tax": 0,
                        "base_tax_amount": 0,
                        "base_tax_before_discount": 0,
                        "base_tax_invoiced": 0,
                        "base_tax_refunded": 0,
                        "base_weee_tax_applied_amount": 0,
                        "base_weee_tax_applied_row_amnt": 0,
                        "base_weee_tax_disposition": 0,
                        "base_weee_tax_row_disposition": 0,
                        "created_at": "string",
                        "description": "string",
                        "discount_amount": 0,
                        "discount_invoiced": 0,
                        "discount_percent": 0,
                        "discount_refunded": 0,
                        "discount_tax_compensation_amount": 0,
                        "discount_tax_compensation_canceled": 0,
                        "discount_tax_compensation_invoiced": 0,
                        "discount_tax_compensation_refunded": 0,
                        "event_id": 0,
                        "ext_order_item_id": "string",
                        "extension_attributes": {
                            "gift_message": {
                                "customer_id": 0,
                                "extension_attributes": {
                                    "entity_id": "string",
                                    "entity_type": "string",
                                    "wrapping_add_printed_card": true,
                                    "wrapping_allow_gift_receipt": true,
                                    "wrapping_id": 0
                                },
                                "gift_message_id": 0,
                                "message": "string",
                                "recipient": "string",
                                "sender": "string"
                            },
                            "gw_base_price": "string",
                            "gw_base_price_invoiced": "string",
                            "gw_base_price_refunded": "string",
                            "gw_base_tax_amount": "string",
                            "gw_base_tax_amount_invoiced": "string",
                            "gw_base_tax_amount_refunded": "string",
                            "gw_id": "string",
                            "gw_price": "string",
                            "gw_price_invoiced": "string",
                            "gw_price_refunded": "string",
                            "gw_tax_amount": "string",
                            "gw_tax_amount_invoiced": "string",
                            "gw_tax_amount_refunded": "string",
                            "invoice_text_codes": [
                                "string"
                            ],
                            "tax_codes": [
                                "string"
                            ],
                            "vertex_tax_codes": [
                                "string"
                            ]
                        },
                        "free_shipping": 0,
                        "gw_base_price": 0,
                        "gw_base_price_invoiced": 0,
                        "gw_base_price_refunded": 0,
                        "gw_base_tax_amount": 0,
                        "gw_base_tax_amount_invoiced": 0,
                        "gw_base_tax_amount_refunded": 0,
                        "gw_id": 0,
                        "gw_price": 0,
                        "gw_price_invoiced": 0,
                        "gw_price_refunded": 0,
                        "gw_tax_amount": 0,
                        "gw_tax_amount_invoiced": 0,
                        "gw_tax_amount_refunded": 0,
                        "is_qty_decimal": 0,
                        "is_virtual": 0,
                        "item_id": 0,
                        "locked_do_invoice": 0,
                        "locked_do_ship": 0,
                        "name": "string",
                        "no_discount": 0,
                        "order_id": 0,
                        "original_price": 0,
                        "parent_item": {},
                        "parent_item_id": 0,
                        "price": 0,
                        "price_incl_tax": 0,
                        "product_id": 0,
                        "product_option": {
                            "extension_attributes": {
                                "bundle_options": [
                                    {
                                        "extension_attributes": {},
                                        "option_id": 0,
                                        "option_qty": 0,
                                        "option_selections": [
                                            0
                                        ]
                                    }
                                ],
                                "configurable_item_options": [
                                    {
                                        "extension_attributes": {},
                                        "option_id": "string",
                                        "option_value": 0
                                    }
                                ],
                                "custom_options": [
                                    {
                                        "extension_attributes": {
                                            "file_info": {
                                                "base64_encoded_data": "string",
                                                "name": "string",
                                                "type": "string"
                                            }
                                        },
                                        "option_id": "string",
                                        "option_value": "string"
                                    }
                                ],
                                "downloadable_option": {
                                    "downloadable_links": [
                                        0
                                    ]
                                },
                                "giftcard_item_option": {
                                    "custom_giftcard_amount": 0,
                                    "extension_attributes": {},
                                    "giftcard_amount": "string",
                                    "giftcard_message": "string",
                                    "giftcard_recipient_email": "string",
                                    "giftcard_recipient_name": "string",
                                    "giftcard_sender_email": "string",
                                    "giftcard_sender_name": "string"
                                }
                            }
                        },
                        "product_type": "string",
                        "qty_backordered": 0,
                        "qty_canceled": 0,
                        "qty_invoiced": 0,
                        "qty_ordered": 0,
                        "qty_refunded": 0,
                        "qty_returned": 0,
                        "qty_shipped": 0,
                        "quote_item_id": 0,
                        "row_invoiced": 0,
                        "row_total": 0,
                        "row_total_incl_tax": 0,
                        "row_weight": 0,
                        "sku": "string",
                        "store_id": 0,
                        "tax_amount": 0,
                        "tax_before_discount": 0,
                        "tax_canceled": 0,
                        "tax_invoiced": 0,
                        "tax_percent": 0,
                        "tax_refunded": 0,
                        "updated_at": "string",
                        "weee_tax_applied": "string",
                        "weee_tax_applied_amount": 0,
                        "weee_tax_applied_row_amount": 0,
                        "weee_tax_disposition": 0,
                        "weee_tax_row_disposition": 0,
                        "weight": 0
                    }
                ],
                "shipping": {
                    "address": {
                        "address_type": "string",
                        "city": "string",
                        "company": "string",
                        "country_id": "string",
                        "customer_address_id": 0,
                        "customer_id": 0,
                        "email": "string",
                        "entity_id": 0,
                        "extension_attributes": {
                            "checkout_fields": [
                                {
                                    "attribute_code": "string",
                                    "value": "string"
                                }
                            ]
                        },
                        "fax": "string",
                        "firstname": "string",
                        "lastname": "string",
                        "middlename": "string",
                        "parent_id": 0,
                        "postcode": "string",
                        "prefix": "string",
                        "region": "string",
                        "region_code": "string",
                        "region_id": 0,
                        "street": [
                            "string"
                        ],
                        "suffix": "string",
                        "telephone": "string",
                        "vat_id": "string",
                        "vat_is_valid": 0,
                        "vat_request_date": "string",
                        "vat_request_id": "string",
                        "vat_request_success": 0
                    },
                    "extension_attributes": {
                        "collection_point": {
                            "city": "string",
                            "collection_point_id": "string",
                            "country": "string",
                            "name": "string",
                            "postcode": "string",
                            "recipient_address_id": 0,
                            "region": "string",
                            "street": [
                                "string"
                            ]
                        },
                        "ext_order_id": "string",
                        "shipping_experience": {
                            "code": "string",
                            "cost": 0,
                            "label": "string"
                        }
                    },
                    "method": "string",
                    "total": {
                        "base_shipping_amount": 0,
                        "base_shipping_canceled": 0,
                        "base_shipping_discount_amount": 0,
                        "base_shipping_discount_tax_compensation_amnt": 0,
                        "base_shipping_incl_tax": 0,
                        "base_shipping_invoiced": 0,
                        "base_shipping_refunded": 0,
                        "base_shipping_tax_amount": 0,
                        "base_shipping_tax_refunded": 0,
                        "extension_attributes": {},
                        "shipping_amount": 0,
                        "shipping_canceled": 0,
                        "shipping_discount_amount": 0,
                        "shipping_discount_tax_compensation_amount": 0,
                        "shipping_incl_tax": 0,
                        "shipping_invoiced": 0,
                        "shipping_refunded": 0,
                        "shipping_tax_amount": 0,
                        "shipping_tax_refunded": 0
                    }
                },
                "stock_id": 0
            }
        ]
    },
    "forced_shipment_with_invoice": 0,
    "global_currency_code": "string",
    "grand_total": 0,
    "hold_before_state": "string",
    "hold_before_status": "string",
    "increment_id": "string",
    "is_virtual": 0,
    "items": [
        {
            "additional_data": "string",
            "amount_refunded": 0,
            "applied_rule_ids": "string",
            "base_amount_refunded": 0,
            "base_cost": 0,
            "base_discount_amount": 0,
            "base_discount_invoiced": 0,
            "base_discount_refunded": 0,
            "base_discount_tax_compensation_amount": 0,
            "base_discount_tax_compensation_invoiced": 0,
            "base_discount_tax_compensation_refunded": 0,
            "base_original_price": 0,
            "base_price": 0,
            "base_price_incl_tax": 0,
            "base_row_invoiced": 0,
            "base_row_total": 0,
            "base_row_total_incl_tax": 0,
            "base_tax_amount": 0,
            "base_tax_before_discount": 0,
            "base_tax_invoiced": 0,
            "base_tax_refunded": 0,
            "base_weee_tax_applied_amount": 0,
            "base_weee_tax_applied_row_amnt": 0,
            "base_weee_tax_disposition": 0,
            "base_weee_tax_row_disposition": 0,
            "created_at": "string",
            "description": "string",
            "discount_amount": 0,
            "discount_invoiced": 0,
            "discount_percent": 0,
            "discount_refunded": 0,
            "discount_tax_compensation_amount": 0,
            "discount_tax_compensation_canceled": 0,
            "discount_tax_compensation_invoiced": 0,
            "discount_tax_compensation_refunded": 0,
            "event_id": 0,
            "ext_order_item_id": "string",
            "extension_attributes": {
                "gift_message": {
                    "customer_id": 0,
                    "extension_attributes": {
                        "entity_id": "string",
                        "entity_type": "string",
                        "wrapping_add_printed_card": true,
                        "wrapping_allow_gift_receipt": true,
                        "wrapping_id": 0
                    },
                    "gift_message_id": 0,
                    "message": "string",
                    "recipient": "string",
                    "sender": "string"
                },
                "gw_base_price": "string",
                "gw_base_price_invoiced": "string",
                "gw_base_price_refunded": "string",
                "gw_base_tax_amount": "string",
                "gw_base_tax_amount_invoiced": "string",
                "gw_base_tax_amount_refunded": "string",
                "gw_id": "string",
                "gw_price": "string",
                "gw_price_invoiced": "string",
                "gw_price_refunded": "string",
                "gw_tax_amount": "string",
                "gw_tax_amount_invoiced": "string",
                "gw_tax_amount_refunded": "string",
                "invoice_text_codes": [
                    "string"
                ],
                "tax_codes": [
                    "string"
                ],
                "vertex_tax_codes": [
                    "string"
                ]
            },
            "free_shipping": 0,
            "gw_base_price": 0,
            "gw_base_price_invoiced": 0,
            "gw_base_price_refunded": 0,
            "gw_base_tax_amount": 0,
            "gw_base_tax_amount_invoiced": 0,
            "gw_base_tax_amount_refunded": 0,
            "gw_id": 0,
            "gw_price": 0,
            "gw_price_invoiced": 0,
            "gw_price_refunded": 0,
            "gw_tax_amount": 0,
            "gw_tax_amount_invoiced": 0,
            "gw_tax_amount_refunded": 0,
            "is_qty_decimal": 0,
            "is_virtual": 0,
            "item_id": 0,
            "locked_do_invoice": 0,
            "locked_do_ship": 0,
            "name": "string",
            "no_discount": 0,
            "order_id": 0,
            "original_price": 0,
            "parent_item": {},
            "parent_item_id": 0,
            "price": 0,
            "price_incl_tax": 0,
            "product_id": 0,
            "product_option": {
                "extension_attributes": {
                    "bundle_options": [
                        {
                            "extension_attributes": {},
                            "option_id": 0,
                            "option_qty": 0,
                            "option_selections": [
                                0
                            ]
                        }
                    ],
                    "configurable_item_options": [
                        {
                            "extension_attributes": {},
                            "option_id": "string",
                            "option_value": 0
                        }
                    ],
                    "custom_options": [
                        {
                            "extension_attributes": {
                                "file_info": {
                                    "base64_encoded_data": "string",
                                    "name": "string",
                                    "type": "string"
                                }
                            },
                            "option_id": "string",
                            "option_value": "string"
                        }
                    ],
                    "downloadable_option": {
                        "downloadable_links": [
                            0
                        ]
                    },
                    "giftcard_item_option": {
                        "custom_giftcard_amount": 0,
                        "extension_attributes": {},
                        "giftcard_amount": "string",
                        "giftcard_message": "string",
                        "giftcard_recipient_email": "string",
                        "giftcard_recipient_name": "string",
                        "giftcard_sender_email": "string",
                        "giftcard_sender_name": "string"
                    }
                }
            },
            "product_type": "string",
            "qty_backordered": 0,
            "qty_canceled": 0,
            "qty_invoiced": 0,
            "qty_ordered": 0,
            "qty_refunded": 0,
            "qty_returned": 0,
            "qty_shipped": 0,
            "quote_item_id": 0,
            "row_invoiced": 0,
            "row_total": 0,
            "row_total_incl_tax": 0,
            "row_weight": 0,
            "sku": "string",
            "store_id": 0,
            "tax_amount": 0,
            "tax_before_discount": 0,
            "tax_canceled": 0,
            "tax_invoiced": 0,
            "tax_percent": 0,
            "tax_refunded": 0,
            "updated_at": "string",
            "weee_tax_applied": "string",
            "weee_tax_applied_amount": 0,
            "weee_tax_applied_row_amount": 0,
            "weee_tax_disposition": 0,
            "weee_tax_row_disposition": 0,
            "weight": 0
        }
    ],
    "order_currency_code": "string",
    "original_increment_id": "string",
    "payment": {
        "account_status": "string",
        "additional_data": "string",
        "additional_information": [
            "string"
        ],
        "address_status": "string",
        "amount_authorized": 0,
        "amount_canceled": 0,
        "amount_ordered": 0,
        "amount_paid": 0,
        "amount_refunded": 0,
        "anet_trans_method": "string",
        "base_amount_authorized": 0,
        "base_amount_canceled": 0,
        "base_amount_ordered": 0,
        "base_amount_paid": 0,
        "base_amount_paid_online": 0,
        "base_amount_refunded": 0,
        "base_amount_refunded_online": 0,
        "base_shipping_amount": 0,
        "base_shipping_captured": 0,
        "base_shipping_refunded": 0,
        "cc_approval": "string",
        "cc_avs_status": "string",
        "cc_cid_status": "string",
        "cc_debug_request_body": "string",
        "cc_debug_response_body": "string",
        "cc_debug_response_serialized": "string",
        "cc_exp_month": "string",
        "cc_exp_year": "string",
        "cc_last4": "string",
        "cc_number_enc": "string",
        "cc_owner": "string",
        "cc_secure_verify": "string",
        "cc_ss_issue": "string",
        "cc_ss_start_month": "string",
        "cc_ss_start_year": "string",
        "cc_status": "string",
        "cc_status_description": "string",
        "cc_trans_id": "string",
        "cc_type": "string",
        "echeck_account_name": "string",
        "echeck_account_type": "string",
        "echeck_bank_name": "string",
        "echeck_routing_number": "string",
        "echeck_type": "string",
        "entity_id": 0,
        "extension_attributes": {
            "vault_payment_token": {
                "created_at": "string",
                "customer_id": 0,
                "entity_id": 0,
                "expires_at": "string",
                "gateway_token": "string",
                "is_active": true,
                "is_visible": true,
                "payment_method_code": "string",
                "public_hash": "string",
                "token_details": "string",
                "type": "string"
            }
        },
        "last_trans_id": "string",
        "method": "string",
        "parent_id": 0,
        "po_number": "string",
        "protection_eligibility": "string",
        "quote_payment_id": 0,
        "shipping_amount": 0,
        "shipping_captured": 0,
        "shipping_refunded": 0
    },
    "payment_auth_expiration": 0,
    "payment_authorization_amount": 0,
    "protect_code": "string",
    "quote_address_id": 0,
    "quote_id": 0,
    "relation_child_id": "string",
    "relation_child_real_id": "string",
    "relation_parent_id": "string",
    "relation_parent_real_id": "string",
    "remote_ip": "string",
    "shipping_amount": 0,
    "shipping_canceled": 0,
    "shipping_description": "string",
    "shipping_discount_amount": 0,
    "shipping_discount_tax_compensation_amount": 0,
    "shipping_incl_tax": 0,
    "shipping_invoiced": 0,
    "shipping_refunded": 0,
    "shipping_tax_amount": 0,
    "shipping_tax_refunded": 0,
    "state": "string",
    "status": "string",
    "status_histories": [
        {
            "comment": "string",
            "created_at": "string",
            "entity_id": 0,
            "entity_name": "string",
            "extension_attributes": {},
            "is_customer_notified": 0,
            "is_visible_on_front": 0,
            "parent_id": 0,
            "status": "string"
        }
    ],
    "store_currency_code": "string",
    "store_id": 0,
    "store_name": "string",
    "store_to_base_rate": 0,
    "store_to_order_rate": 0,
    "subtotal": 0,
    "subtotal_canceled": 0,
    "subtotal_incl_tax": 0,
    "subtotal_invoiced": 0,
    "subtotal_refunded": 0,
    "tax_amount": 0,
    "tax_canceled": 0,
    "tax_invoiced": 0,
    "tax_refunded": 0,
    "total_canceled": 0,
    "total_due": 0,
    "total_invoiced": 0,
    "total_item_count": 0,
    "total_offline_refunded": 0,
    "total_online_refunded": 0,
    "total_paid": 0,
    "total_qty_ordered": 0,
    "total_refunded": 0,
    "updated_at": "string",
    "weight": 0,
    "x_forwarded_for": "string"
}

请求参数

Path 参数
id
integer 
必需
The order ID.

返回响应

🟢200成功
application/json
200 Success.
Body
Order interface. An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as a purchase order, is emailed to the customer.
adjustment_negative
number 
可选
Negative adjustment value.
adjustment_positive
number 
可选
Positive adjustment value.
applied_rule_ids
string 
可选
Applied rule IDs.
base_adjustment_negative
number 
可选
Base negative adjustment value.
base_adjustment_positive
number 
可选
Base positive adjustment value.
base_currency_code
string 
可选
Base currency code.
base_discount_amount
number 
可选
Base discount amount.
base_discount_canceled
number 
可选
Base discount canceled.
base_discount_invoiced
number 
可选
Base discount invoiced.
base_discount_refunded
number 
可选
Base discount refunded.
base_discount_tax_compensation_amount
number 
可选
Base discount tax compensation amount.
base_discount_tax_compensation_invoiced
number 
可选
Base discount tax compensation invoiced.
base_discount_tax_compensation_refunded
number 
可选
Base discount tax compensation refunded.
base_grand_total
number 
必需
Base grand total.
base_shipping_amount
number 
可选
Base shipping amount.
base_shipping_canceled
number 
可选
Base shipping canceled.
base_shipping_discount_amount
number 
可选
Base shipping discount amount.
base_shipping_discount_tax_compensation_amnt
number 
可选
Base shipping discount tax compensation amount.
base_shipping_incl_tax
number 
可选
Base shipping including tax.
base_shipping_invoiced
number 
可选
Base shipping invoiced.
base_shipping_refunded
number 
可选
Base shipping refunded.
base_shipping_tax_amount
number 
可选
Base shipping tax amount.
base_shipping_tax_refunded
number 
可选
Base shipping tax refunded.
base_subtotal
number 
可选
Base subtotal.
base_subtotal_canceled
number 
可选
Base subtotal canceled.
base_subtotal_incl_tax
number 
可选
Base subtotal including tax.
base_subtotal_invoiced
number 
可选
Base subtotal invoiced.
base_subtotal_refunded
number 
可选
Base subtotal refunded.
base_tax_amount
number 
可选
Base tax amount.
base_tax_canceled
number 
可选
Base tax canceled.
base_tax_invoiced
number 
可选
Base tax invoiced.
base_tax_refunded
number 
可选
Base tax refunded.
base_to_global_rate
number 
可选
Base-to-global rate.
base_to_order_rate
number 
可选
Base-to-order rate.
base_total_canceled
number 
可选
Base total canceled.
base_total_due
number 
可选
Base total due.
base_total_invoiced
number 
可选
Base total invoiced.
base_total_invoiced_cost
number 
可选
Base total invoiced cost.
base_total_offline_refunded
number 
可选
Base total offline refunded.
base_total_online_refunded
number 
可选
Base total online refunded.
base_total_paid
number 
可选
Base total paid.
base_total_qty_ordered
number 
可选
Base total quantity ordered.
base_total_refunded
number 
可选
Base total refunded.
billing_address
object (sales-data-order-address-interface) 
可选
Order address interface. An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as a purchase order, is emailed to the customer.
address_type
string 
必需
Address type.
city
string 
City.
必需
company
string 
Company.
可选
country_id
string 
必需
Country ID.
customer_address_id
integer 
可选
Country address ID.
customer_id
integer 
可选
Customer ID.
email
string 
可选
Email address.
entity_id
integer 
可选
Order address ID.
extension_attributes
object (sales-data-order-address-extension-interface) 
可选
ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderAddressInterface
fax
string 
可选
Fax number.
firstname
string 
必需
First name.
lastname
string 
必需
Last name.
middlename
string 
可选
Middle name.
parent_id
integer 
可选
Parent ID.
postcode
string 
必需
Postal code.
prefix
string 
Prefix.
可选
region
string 
Region.
可选
region_code
string 
可选
Region code.
region_id
integer 
可选
Region ID.
street
array[string]
可选
Array of any street values. Otherwise, null.
suffix
string 
Suffix.
可选
telephone
string 
必需
Telephone number.
vat_id
string 
VAT ID.
可选
vat_is_valid
integer 
可选
VAT-is-valid flag value.
vat_request_date
string 
可选
VAT request date.
vat_request_id
string 
可选
VAT request ID.
vat_request_success
integer 
可选
VAT-request-success flag value.
billing_address_id
integer 
可选
Billing address ID.
can_ship_partially
integer 
可选
Can-ship-partially flag value.
can_ship_partially_item
integer 
可选
Can-ship-partially-item flag value.
coupon_code
string 
可选
Coupon code.
created_at
string 
可选
Created-at timestamp.
customer_dob
string 
可选
Customer date-of-birth (DOB).
customer_email
string 
必需
Customer email address.
customer_firstname
string 
可选
Customer first name.
customer_gender
integer 
可选
Customer gender.
customer_group_id
integer 
可选
Customer group ID.
customer_id
integer 
可选
Customer ID.
customer_is_guest
integer 
可选
Customer-is-guest flag value.
customer_lastname
string 
可选
Customer last name.
customer_middlename
string 
可选
Customer middle name.
customer_note
string 
可选
Customer note.
customer_note_notify
integer 
可选
Customer-note-notify flag value.
customer_prefix
string 
可选
Customer prefix.
customer_suffix
string 
可选
Customer suffix.
customer_taxvat
string 
可选
Customer value-added tax (VAT).
discount_amount
number 
可选
Discount amount.
discount_canceled
number 
可选
Discount canceled.
discount_description
string 
可选
Discount description.
discount_invoiced
number 
可选
Discount invoiced.
discount_refunded
number 
可选
Discount refunded amount.
discount_tax_compensation_amount
number 
可选
Discount tax compensation amount.
discount_tax_compensation_invoiced
number 
可选
Discount tax compensation invoiced amount.
discount_tax_compensation_refunded
number 
可选
Discount tax compensation refunded amount.
edit_increment
integer 
可选
Edit increment value.
email_sent
integer 
可选
Email-sent flag value.
entity_id
integer 
Order ID.
可选
ext_customer_id
string 
可选
External customer ID.
ext_order_id
string 
可选
External order ID.
extension_attributes
object (sales-data-order-extension-interface) 
可选
ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderInterface
amazon_order_reference_id
string 
可选
applied_taxes
array[object (tax-data-order-tax-details-applied-tax-interface) {6}] 
可选
base_customer_balance_amount
number 
可选
base_customer_balance_invoiced
number 
可选
base_customer_balance_refunded
number 
可选
base_customer_balance_total_refunded
number 
可选
base_gift_cards_amount
number 
可选
base_gift_cards_invoiced
number 
可选
base_gift_cards_refunded
number 
可选
base_reward_currency_amount
number 
可选
company_order_attributes
object (company-data-company-order-interface) 
可选
Order company extension attributes interface. Adds new company attributes to orders.
converting_from_quote
boolean 
可选
customer_balance_amount
number 
可选
customer_balance_invoiced
number 
可选
customer_balance_refunded
number 
可选
customer_balance_total_refunded
number 
可选
gift_cards
array[object (gift-card-account-data-gift-card-interface) {4}] 
可选
gift_cards_amount
number 
可选
gift_cards_invoiced
number 
可选
gift_cards_refunded
number 
可选
gift_message
object (gift-message-data-message-interface) 
可选
Interface MessageInterface
gw_add_card
string 
可选
gw_allow_gift_receipt
string 
可选
gw_base_price
string 
可选
gw_base_price_incl_tax
string 
可选
gw_base_price_invoiced
string 
可选
gw_base_price_refunded
string 
可选
gw_base_tax_amount
string 
可选
gw_base_tax_amount_invoiced
string 
可选
gw_base_tax_amount_refunded
string 
可选
gw_card_base_price
string 
可选
gw_card_base_price_incl_tax
string 
可选
gw_card_base_price_invoiced
string 
可选
gw_card_base_price_refunded
string 
可选
gw_card_base_tax_amount
string 
可选
gw_card_base_tax_invoiced
string 
可选
gw_card_base_tax_refunded
string 
可选
gw_card_price
string 
可选
gw_card_price_incl_tax
string 
可选
gw_card_price_invoiced
string 
可选
gw_card_price_refunded
string 
可选
gw_card_tax_amount
string 
可选
gw_card_tax_invoiced
string 
可选
gw_card_tax_refunded
string 
可选
gw_id
string 
可选
gw_items_base_price
string 
可选
gw_items_base_price_incl_tax
string 
可选
gw_items_base_price_invoiced
string 
可选
gw_items_base_price_refunded
string 
可选
gw_items_base_tax_amount
string 
可选
gw_items_base_tax_invoiced
string 
可选
gw_items_base_tax_refunded
string 
可选
gw_items_price
string 
可选
gw_items_price_incl_tax
string 
可选
gw_items_price_invoiced
string 
可选
gw_items_price_refunded
string 
可选
gw_items_tax_amount
string 
可选
gw_items_tax_invoiced
string 
可选
gw_items_tax_refunded
string 
可选
gw_price
string 
可选
gw_price_incl_tax
string 
可选
gw_price_invoiced
string 
可选
gw_price_refunded
string 
可选
gw_tax_amount
string 
可选
gw_tax_amount_invoiced
string 
可选
gw_tax_amount_refunded
string 
可选
item_applied_taxes
array[object (tax-data-order-tax-details-item-interface) {5}] 
可选
payment_additional_info
array[object (payment-data-payment-additional-info-interface) {2}] 
可选
reward_currency_amount
number 
可选
reward_points_balance
integer 
可选
shipping_assignments
array[object (sales-data-shipping-assignment-interface) {4}] 
可选
forced_shipment_with_invoice
integer 
可选
Forced-shipment-with-invoice flag value.
global_currency_code
string 
可选
Global currency code.
grand_total
number 
必需
Grand total.
hold_before_state
string 
可选
Hold before state.
hold_before_status
string 
可选
Hold before status.
increment_id
string 
可选
Increment ID.
is_virtual
integer 
可选
Is-virtual flag value.
items
array[object (sales-data-order-item-interface) {95}] 
必需
Array of items.
additional_data
string 
可选
Additional data.
amount_refunded
number 
可选
Amount refunded.
applied_rule_ids
string 
可选
Applied rule IDs.
base_amount_refunded
number 
可选
Base amount refunded.
base_cost
number 
可选
Base cost.
base_discount_amount
number 
可选
Base discount amount.
base_discount_invoiced
number 
可选
Base discount invoiced.
base_discount_refunded
number 
可选
Base discount refunded.
base_discount_tax_compensation_amount
number 
可选
Base discount tax compensation amount.
base_discount_tax_compensation_invoiced
number 
可选
Base discount tax compensation invoiced.
base_discount_tax_compensation_refunded
number 
可选
Base discount tax compensation refunded.
base_original_price
number 
可选
Base original price.
base_price
number 
可选
Base price.
base_price_incl_tax
number 
可选
Base price including tax.
base_row_invoiced
number 
可选
Base row invoiced.
base_row_total
number 
可选
Base row total.
base_row_total_incl_tax
number 
可选
Base row total including tax.
base_tax_amount
number 
可选
Base tax amount.
base_tax_before_discount
number 
可选
Base tax before discount.
base_tax_invoiced
number 
可选
Base tax invoiced.
base_tax_refunded
number 
可选
Base tax refunded.
base_weee_tax_applied_amount
number 
可选
Base WEEE tax applied amount.
base_weee_tax_applied_row_amnt
number 
可选
Base WEEE tax applied row amount.
base_weee_tax_disposition
number 
可选
Base WEEE tax disposition.
base_weee_tax_row_disposition
number 
可选
Base WEEE tax row disposition.
created_at
string 
可选
Created-at timestamp.
description
string 
可选
Description.
discount_amount
number 
可选
Discount amount.
discount_invoiced
number 
可选
Discount invoiced.
discount_percent
number 
可选
Discount percent.
discount_refunded
number 
可选
Discount refunded.
discount_tax_compensation_amount
number 
可选
Discount tax compensation amount.
discount_tax_compensation_canceled
number 
可选
Discount tax compensation canceled.
discount_tax_compensation_invoiced
number 
可选
Discount tax compensation invoiced.
discount_tax_compensation_refunded
number 
可选
Discount tax compensation refunded.
event_id
integer 
Event ID.
可选
ext_order_item_id
string 
可选
External order item ID.
extension_attributes
object (sales-data-order-item-extension-interface) 
可选
ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderItemInterface
free_shipping
integer 
可选
Free-shipping flag value.
gw_base_price
number 
可选
GW base price.
gw_base_price_invoiced
number 
可选
GW base price invoiced.
gw_base_price_refunded
number 
可选
GW base price refunded.
gw_base_tax_amount
number 
可选
GW base tax amount.
gw_base_tax_amount_invoiced
number 
可选
GW base tax amount invoiced.
gw_base_tax_amount_refunded
number 
可选
GW base tax amount refunded.
gw_id
integer 
GW ID.
可选
gw_price
number 
GW price.
可选
gw_price_invoiced
number 
可选
GW price invoiced.
gw_price_refunded
number 
可选
GW price refunded.
gw_tax_amount
number 
可选
GW tax amount.
gw_tax_amount_invoiced
number 
可选
GW tax amount invoiced.
gw_tax_amount_refunded
number 
可选
GW tax amount refunded.
is_qty_decimal
integer 
可选
Is-quantity-decimal flag value.
is_virtual
integer 
可选
Is-virtual flag value.
item_id
integer 
Item ID.
可选
locked_do_invoice
integer 
可选
Locked DO invoice flag value.
locked_do_ship
integer 
可选
Locked DO ship flag value.
name
string 
Name.
可选
no_discount
integer 
可选
No-discount flag value.
order_id
integer 
Order ID.
可选
original_price
number 
可选
Original price.
parent_item
object (sales-data-order-item-interface) 
可选
Order item interface. An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as a purchase order, is emailed to the customer.
parent_item_id
integer 
可选
Parent item ID.
price
number 
Price.
可选
price_incl_tax
number 
可选
Price including tax.
product_id
integer 
可选
Product ID.
product_option
object (catalog-data-product-option-interface) 
可选
Product option interface
product_type
string 
可选
Product type.
qty_backordered
number 
可选
Quantity backordered.
qty_canceled
number 
可选
Quantity canceled.
qty_invoiced
number 
可选
Quantity invoiced.
qty_ordered
number 
可选
Quantity ordered.
qty_refunded
number 
可选
Quantity refunded.
qty_returned
number 
可选
Quantity returned.
qty_shipped
number 
可选
Quantity shipped.
quote_item_id
integer 
可选
Quote item ID.
row_invoiced
number 
可选
Row invoiced.
row_total
number 
可选
Row total.
row_total_incl_tax
number 
可选
Row total including tax.
row_weight
number 
可选
Row weight.
sku
string 
SKU.
必需
store_id
integer 
Store ID.
可选
tax_amount
number 
可选
Tax amount.
tax_before_discount
number 
可选
Tax before discount.
tax_canceled
number 
可选
Tax canceled.
tax_invoiced
number 
可选
Tax invoiced.
tax_percent
number 
可选
Tax percent.
tax_refunded
number 
可选
Tax refunded.
updated_at
string 
可选
Updated-at timestamp.
weee_tax_applied
string 
可选
WEEE tax applied.
weee_tax_applied_amount
number 
可选
WEEE tax applied amount.
weee_tax_applied_row_amount
number 
可选
WEEE tax applied row amount.
weee_tax_disposition
number 
可选
WEEE tax disposition.
weee_tax_row_disposition
number 
可选
WEEE tax row disposition.
weight
number 
Weight.
可选
order_currency_code
string 
可选
Order currency code.
original_increment_id
string 
可选
Original increment ID.
payment
object (sales-data-order-payment-interface) 
可选
Order payment interface. An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as a purchase order, is emailed to the customer.
account_status
string 
必需
Account status.
additional_data
string 
可选
Additional data.
additional_information
array[string]
必需
Array of additional information.
address_status
string 
可选
Address status.
amount_authorized
number 
可选
Amount authorized.
amount_canceled
number 
可选
Amount canceled.
amount_ordered
number 
可选
Amount ordered.
amount_paid
number 
可选
Amount paid.
amount_refunded
number 
可选
Amount refunded.
anet_trans_method
string 
可选
Anet transaction method.
base_amount_authorized
number 
可选
Base amount authorized.
base_amount_canceled
number 
可选
Base amount canceled.
base_amount_ordered
number 
可选
Base amount ordered.
base_amount_paid
number 
可选
Base amount paid.
base_amount_paid_online
number 
可选
Base amount paid online.
base_amount_refunded
number 
可选
Base amount refunded.
base_amount_refunded_online
number 
可选
Base amount refunded online.
base_shipping_amount
number 
可选
Base shipping amount.
base_shipping_captured
number 
可选
Base shipping captured amount.
base_shipping_refunded
number 
可选
Base shipping refunded amount.
cc_approval
string 
可选
Credit card approval.
cc_avs_status
string 
可选
Credit card avs status.
cc_cid_status
string 
可选
Credit card CID status.
cc_debug_request_body
string 
可选
Credit card debug request body.
cc_debug_response_body
string 
可选
Credit card debug response body.
cc_debug_response_serialized
string 
可选
Credit card debug response serialized.
cc_exp_month
string 
可选
Credit card expiration month.
cc_exp_year
string 
可选
Credit card expiration year.
cc_last4
string 
必需
Last four digits of the credit card.
cc_number_enc
string 
可选
Encrypted credit card number.
cc_owner
string 
可选
Credit card number.
cc_secure_verify
string 
可选
Credit card secure verify.
cc_ss_issue
string 
可选
Credit card SS issue.
cc_ss_start_month
string 
可选
Credit card SS start month.
cc_ss_start_year
string 
可选
Credit card SS start year.
cc_status
string 
可选
Credit card status.
cc_status_description
string 
可选
Credit card status description.
cc_trans_id
string 
可选
Credit card transaction ID.
cc_type
string 
可选
Credit card type.
echeck_account_name
string 
可选
eCheck account name.
echeck_account_type
string 
可选
eCheck account type.
echeck_bank_name
string 
可选
eCheck bank name.
echeck_routing_number
string 
可选
eCheck routing number.
echeck_type
string 
可选
eCheck type.
entity_id
integer 
可选
Entity ID.
extension_attributes
object (sales-data-order-payment-extension-interface) 
可选
ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderPaymentInterface
last_trans_id
string 
可选
Last transaction ID.
method
string 
Method.
必需
parent_id
integer 
可选
Parent ID.
po_number
string 
可选
PO number.
protection_eligibility
string 
可选
Protection eligibility.
quote_payment_id
integer 
可选
Quote payment ID.
shipping_amount
number 
可选
Shipping amount.
shipping_captured
number 
可选
Shipping captured.
shipping_refunded
number 
可选
Shipping refunded.
payment_auth_expiration
integer 
可选
Payment authorization expiration date.
payment_authorization_amount
number 
可选
Payment authorization amount.
protect_code
string 
可选
Protect code.
quote_address_id
integer 
可选
Quote address ID.
quote_id
integer 
Quote ID.
可选
relation_child_id
string 
可选
Relation child ID.
relation_child_real_id
string 
可选
Relation child real ID.
relation_parent_id
string 
可选
Relation parent ID.
relation_parent_real_id
string 
可选
Relation parent real ID.
remote_ip
string 
可选
Remote IP address.
shipping_amount
number 
可选
Shipping amount.
shipping_canceled
number 
可选
Shipping canceled amount.
shipping_description
string 
可选
Shipping description.
shipping_discount_amount
number 
可选
Shipping discount amount.
shipping_discount_tax_compensation_amount
number 
可选
Shipping discount tax compensation amount.
shipping_incl_tax
number 
可选
Shipping including tax amount.
shipping_invoiced
number 
可选
Shipping invoiced amount.
shipping_refunded
number 
可选
Shipping refunded amount.
shipping_tax_amount
number 
可选
Shipping tax amount.
shipping_tax_refunded
number 
可选
Shipping tax refunded amount.
state
string 
State.
可选
status
string 
Status.
可选
status_histories
array[object (sales-data-order-status-history-interface) {9}] 
可选
Array of status histories.
comment
string 
Comment.
必需
created_at
string 
可选
Created-at timestamp.
entity_id
integer 
可选
Order status history ID.
entity_name
string 
可选
Entity name.
extension_attributes
object (sales-data-order-status-history-extension-interface) 
可选
ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderStatusHistoryInterface
is_customer_notified
integer 
必需
Is-customer-notified flag value.
is_visible_on_front
integer 
必需
Is-visible-on-storefront flag value.
parent_id
integer 
必需
Parent ID.
status
string 
Status.
可选
store_currency_code
string 
可选
Store currency code.
store_id
integer 
Store ID.
可选
store_name
string 
可选
Store name.
store_to_base_rate
number 
可选
Store-to-base rate.
store_to_order_rate
number 
可选
Store-to-order rate.
subtotal
number 
Subtotal.
可选
subtotal_canceled
number 
可选
Subtotal canceled amount.
subtotal_incl_tax
number 
可选
Subtotal including tax amount.
subtotal_invoiced
number 
可选
Subtotal invoiced amount.
subtotal_refunded
number 
可选
Subtotal refunded amount.
tax_amount
number 
可选
Tax amount.
tax_canceled
number 
可选
Tax canceled amount.
tax_invoiced
number 
可选
Tax invoiced amount.
tax_refunded
number 
可选
Tax refunded amount.
total_canceled
number 
可选
Total canceled.
total_due
number 
可选
Total due.
total_invoiced
number 
可选
Total invoiced amount.
total_item_count
integer 
可选
Total item count.
total_offline_refunded
number 
可选
Total offline refunded amount.
total_online_refunded
number 
可选
Total online refunded amount.
total_paid
number 
可选
Total paid.
total_qty_ordered
number 
可选
Total quantity ordered.
total_refunded
number 
可选
Total amount refunded.
updated_at
string 
可选
Updated-at timestamp.
weight
number 
Weight.
可选
x_forwarded_for
string 
可选
X-Forwarded-For field value.
🟠401没有权限
🔴500服务器错误
修改于 2024-11-22 03:29:06
上一页
orders/items/{id}
下一页
orders/{id}/cancel
Built with