Magento B2B API
  1. invoices/
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/
      POST
  • 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}
  • 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. invoices/

invoices/

POST
/V1/invoices/
Performs persist operations for a specified invoice.
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'http:///V1/invoices/' \
--header 'Content-Type: application/json' \
--data-raw ''
响应示例响应示例
200 - 示例 1

请求参数

Body 参数application/json
entity
object (sales-data-invoice-interface) 
必需
Invoice interface. An invoice is a record of the receipt of payment for an order.
base_currency_code
string 
可选
Base currency code.
base_discount_amount
number 
可选
Base discount amount.
base_discount_tax_compensation_amount
number 
可选
Base discount tax compensation amount.
base_grand_total
number 
可选
Base grand total.
base_shipping_amount
number 
可选
Base shipping 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_tax_amount
number 
可选
Base shipping tax amount.
base_subtotal
number 
可选
Base subtotal.
base_subtotal_incl_tax
number 
可选
Base subtotal including tax.
base_tax_amount
number 
可选
Base tax amount.
base_to_global_rate
number 
可选
Base-to-global rate.
base_to_order_rate
number 
可选
Base-to-order rate.
base_total_refunded
number 
可选
Base total refunded.
billing_address_id
integer 
可选
Billing address ID.
can_void_flag
integer 
可选
Can void flag value.
comments
array[object (sales-data-invoice-comment-interface) {7}] 
可选
Array of any invoice comments. Otherwise, null.
created_at
string 
可选
Created-at timestamp.
discount_amount
number 
可选
Discount amount.
discount_description
string 
可选
Discount description.
discount_tax_compensation_amount
number 
可选
Discount tax compensation amount.
email_sent
integer 
可选
Email-sent flag value.
entity_id
integer 
可选
Invoice ID.
extension_attributes
object (sales-data-invoice-extension-interface) 
可选
ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceInterface
global_currency_code
string 
可选
Global currency code.
grand_total
number 
可选
Grand total.
increment_id
string 
可选
Increment ID.
is_used_for_refund
integer 
可选
Is-used-for-refund flag value.
items
array[object (sales-data-invoice-item-interface) {25}] 
必需
Array of invoice items.
order_currency_code
string 
可选
Order currency code.
order_id
integer 
Order ID.
必需
shipping_address_id
integer 
可选
Shipping address ID.
shipping_amount
number 
可选
Shipping amount.
shipping_discount_tax_compensation_amount
number 
可选
Shipping discount tax compensation amount.
shipping_incl_tax
number 
可选
Shipping including tax.
shipping_tax_amount
number 
可选
Shipping tax amount.
state
integer 
State.
可选
store_currency_code
string 
可选
Store currency code.
store_id
integer 
Store ID.
可选
store_to_base_rate
number 
可选
Store-to-base rate.
store_to_order_rate
number 
可选
Store-to-order rate.
subtotal
number 
Subtotal.
可选
subtotal_incl_tax
number 
可选
Subtotal including tax.
tax_amount
number 
可选
Tax amount.
total_qty
number 
必需
Total quantity.
transaction_id
string 
可选
Transaction ID.
updated_at
string 
可选
Updated-at timestamp.
示例

返回响应

🟢200成功
application/json
200 Success.
Body
Invoice interface. An invoice is a record of the receipt of payment for an order.
base_currency_code
string 
可选
Base currency code.
base_discount_amount
number 
可选
Base discount amount.
base_discount_tax_compensation_amount
number 
可选
Base discount tax compensation amount.
base_grand_total
number 
可选
Base grand total.
base_shipping_amount
number 
可选
Base shipping 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_tax_amount
number 
可选
Base shipping tax amount.
base_subtotal
number 
可选
Base subtotal.
base_subtotal_incl_tax
number 
可选
Base subtotal including tax.
base_tax_amount
number 
可选
Base tax amount.
base_to_global_rate
number 
可选
Base-to-global rate.
base_to_order_rate
number 
可选
Base-to-order rate.
base_total_refunded
number 
可选
Base total refunded.
billing_address_id
integer 
可选
Billing address ID.
can_void_flag
integer 
可选
Can void flag value.
comments
array[object (sales-data-invoice-comment-interface) {7}] 
可选
Array of any invoice comments. Otherwise, null.
comment
string 
Comment.
必需
created_at
string 
可选
Created-at timestamp.
entity_id
integer 
可选
Invoice ID.
extension_attributes
object (sales-data-invoice-comment-extension-interface) 
可选
ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceCommentInterface
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.
created_at
string 
可选
Created-at timestamp.
discount_amount
number 
可选
Discount amount.
discount_description
string 
可选
Discount description.
discount_tax_compensation_amount
number 
可选
Discount tax compensation amount.
email_sent
integer 
可选
Email-sent flag value.
entity_id
integer 
可选
Invoice ID.
extension_attributes
object (sales-data-invoice-extension-interface) 
可选
ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceInterface
base_customer_balance_amount
number 
可选
base_gift_cards_amount
number 
可选
customer_balance_amount
number 
可选
gift_cards_amount
number 
可选
gw_base_price
string 
可选
gw_base_tax_amount
string 
可选
gw_card_base_price
string 
可选
gw_card_base_tax_amount
string 
可选
gw_card_price
string 
可选
gw_card_tax_amount
string 
可选
gw_items_base_price
string 
可选
gw_items_base_tax_amount
string 
可选
gw_items_price
string 
可选
gw_items_tax_amount
string 
可选
gw_price
string 
可选
gw_tax_amount
string 
可选
vertex_tax_calculation_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.
vertex_tax_calculation_order
object (sales-data-order-interface) 
可选
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.
vertex_tax_calculation_shipping_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.
global_currency_code
string 
可选
Global currency code.
grand_total
number 
可选
Grand total.
increment_id
string 
可选
Increment ID.
is_used_for_refund
integer 
可选
Is-used-for-refund flag value.
items
array[object (sales-data-invoice-item-interface) {25}] 
必需
Array of invoice items.
additional_data
string 
可选
Additional data.
base_cost
number 
可选
Base cost.
base_discount_amount
number 
可选
Base discount amount.
base_discount_tax_compensation_amount
number 
可选
Base discount tax compensation amount.
base_price
number 
可选
Base price.
base_price_incl_tax
number 
可选
Base price including tax.
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.
description
string 
可选
Description.
discount_amount
number 
可选
Discount amount.
discount_tax_compensation_amount
number 
可选
Discount tax compensation amount.
entity_id
integer 
可选
Invoice item ID.
extension_attributes
object (sales-data-invoice-item-extension-interface) 
可选
ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceItemInterface
name
string 
Name.
可选
order_item_id
integer 
必需
Order item ID.
parent_id
integer 
可选
Parent ID.
price
number 
Price.
可选
price_incl_tax
number 
可选
Price including tax.
product_id
integer 
可选
Product ID.
qty
number 
Quantity.
必需
row_total
number 
可选
Row total.
row_total_incl_tax
number 
可选
Row total including tax.
sku
string 
SKU.
必需
tax_amount
number 
可选
Tax amount.
order_currency_code
string 
可选
Order currency code.
order_id
integer 
Order ID.
必需
shipping_address_id
integer 
可选
Shipping address ID.
shipping_amount
number 
可选
Shipping amount.
shipping_discount_tax_compensation_amount
number 
可选
Shipping discount tax compensation amount.
shipping_incl_tax
number 
可选
Shipping including tax.
shipping_tax_amount
number 
可选
Shipping tax amount.
state
integer 
State.
可选
store_currency_code
string 
可选
Store currency code.
store_id
integer 
Store ID.
可选
store_to_base_rate
number 
可选
Store-to-base rate.
store_to_order_rate
number 
可选
Store-to-order rate.
subtotal
number 
Subtotal.
可选
subtotal_incl_tax
number 
可选
Subtotal including tax.
tax_amount
number 
可选
Tax amount.
total_qty
number 
必需
Total quantity.
transaction_id
string 
可选
Transaction ID.
updated_at
string 
可选
Updated-at timestamp.
🟠401没有权限
🔴500服务器错误
修改于 2024-11-22 03:29:06
上一页
invoices
下一页
invoices/comments
Built with