ReDoc documentation
2.4.7-admin
2.4.7-customer
2.4.7-guest
2.4.6-admin
2.4.6-customer
2.4.6-guest
2.4.7-admin
Search
addresses
addresses/{addressId}
del
addresses/{addressId}
adobe_io_events
adobe_io_events/check_configuration
get
adobe_io_events/check_configuration
adobestock
adobestock/asset/list
get
adobestock/asset/list
adobestock/asset/search
get
adobestock/asset/search
adobestock/asset/{id}
del
adobestock/asset/{id}
get
adobestock/asset/{id}
adobestock/search
get
adobestock/search
analytics
analytics/link
get
analytics/link
applepay
applepay/auth
get
applepay/auth
attributeMetadata
attributeMetadata/customer
get
attributeMetadata/customer
attributeMetadata/customer/attribute/{attributeCode}
get
attributeMetadata/customer/attribute/{attributeCode}
attributeMetadata/customer/custom
get
attributeMetadata/customer/custom
attributeMetadata/customer/form/{formCode}
get
attributeMetadata/customer/form/{formCode}
attributeMetadata/customerAddress
get
attributeMetadata/customerAddress
attributeMetadata/customerAddress/attribute/{attributeCode}
get
attributeMetadata/customerAddress/attribute/{attributeCode}
attributeMetadata/customerAddress/custom
get
attributeMetadata/customerAddress/custom
attributeMetadata/customerAddress/form/{formCode}
get
attributeMetadata/customerAddress/form/{formCode}
braintree
braintree/mine/payment/vault
post
braintree/mine/payment/vault
bulk
bulk
get
bulk
bulk/{bulkUuid}/detailed-status
get
bulk/{bulkUuid}/detailed-status
bulk/{bulkUuid}/operation-status/{status}
get
bulk/{bulkUuid}/operation-status/{status}
bulk/{bulkUuid}/status
get
bulk/{bulkUuid}/status
bundle products
bundle-products/options/add
post
bundle-products/options/add
bundle-products/options/types
get
bundle-products/options/types
bundle-products/options/{optionId}
put
bundle-products/options/{optionId}
bundle-products/{productSku}/children
get
bundle-products/{productSku}/children
bundle-products/{sku}/links/{id}
put
bundle-products/{sku}/links/{id}
bundle-products/{sku}/links/{optionId}
post
bundle-products/{sku}/links/{optionId}
bundle-products/{sku}/options/all
get
bundle-products/{sku}/options/all
bundle-products/{sku}/options/{optionId}
get
bundle-products/{sku}/options/{optionId}
del
bundle-products/{sku}/options/{optionId}
bundle-products/{sku}/options/{optionId}/children/{childSku}
del
bundle-products/{sku}/options/{optionId}/children/{childSku}
carts
carts/
post
carts/
carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
get
carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
carts/guest-carts/{cartId}/giftCards
post
carts/guest-carts/{cartId}/giftCards
carts/guest-carts/{cartId}/giftCards/{giftCardCode}
del
carts/guest-carts/{cartId}/giftCards/{giftCardCode}
carts/licence
get
carts/licence
carts/licence/list
get
carts/licence/list
carts/mine
put
carts/mine
post
carts/mine
get
carts/mine
carts/mine/balance/apply
post
carts/mine/balance/apply
carts/mine/billing-address
get
carts/mine/billing-address
post
carts/mine/billing-address
carts/mine/checkGiftCard/{giftCardCode}
get
carts/mine/checkGiftCard/{giftCardCode}
carts/mine/collect-totals
put
carts/mine/collect-totals
carts/mine/coupons
get
carts/mine/coupons
del
carts/mine/coupons
get
carts/mine/coupons
post
carts/mine/coupons
put
carts/mine/coupons
carts/mine/coupons/deleteByCodes
post
carts/mine/coupons/deleteByCodes
carts/mine/coupons/{couponCode}
put
carts/mine/coupons/{couponCode}
carts/mine/estimate-shipping-methods
post
carts/mine/estimate-shipping-methods
carts/mine/estimate-shipping-methods-by-address-id
post
carts/mine/estimate-shipping-methods-by-address-id
carts/mine/gift-message
get
carts/mine/gift-message
post
carts/mine/gift-message
carts/mine/gift-message/{itemId}
get
carts/mine/gift-message/{itemId}
post
carts/mine/gift-message/{itemId}
carts/mine/giftCards
post
carts/mine/giftCards
carts/mine/giftCards/{giftCardCode}
del
carts/mine/giftCards/{giftCardCode}
carts/mine/items
get
carts/mine/items
post
carts/mine/items
carts/mine/items/{itemId}
put
carts/mine/items/{itemId}
del
carts/mine/items/{itemId}
carts/mine/order
put
carts/mine/order
carts/mine/payment-information
post
carts/mine/payment-information
get
carts/mine/payment-information
carts/mine/payment-methods
get
carts/mine/payment-methods
carts/mine/payment-order
post
carts/mine/payment-order
carts/mine/payment-order/{id}
get
carts/mine/payment-order/{id}
post
carts/mine/payment-order/{id}
carts/mine/po-payment-information
post
carts/mine/po-payment-information
carts/mine/selected-payment-method
get
carts/mine/selected-payment-method
put
carts/mine/selected-payment-method
carts/mine/set-payment-information
post
carts/mine/set-payment-information
carts/mine/shipping-information
post
carts/mine/shipping-information
carts/mine/shipping-methods
get
carts/mine/shipping-methods
carts/mine/totals
get
carts/mine/totals
carts/mine/totals-information
post
carts/mine/totals-information
carts/search
get
carts/search
carts/{cartId}
get
carts/{cartId}
put
carts/{cartId}
carts/{cartId}/billing-address
get
carts/{cartId}/billing-address
post
carts/{cartId}/billing-address
carts/{cartId}/coupons
get
carts/{cartId}/coupons
del
carts/{cartId}/coupons
get
carts/{cartId}/coupons
post
carts/{cartId}/coupons
put
carts/{cartId}/coupons
carts/{cartId}/coupons/deleteByCodes
post
carts/{cartId}/coupons/deleteByCodes
carts/{cartId}/coupons/{couponCode}
put
carts/{cartId}/coupons/{couponCode}
carts/{cartId}/estimate-shipping-methods
post
carts/{cartId}/estimate-shipping-methods
carts/{cartId}/estimate-shipping-methods-by-address-id
post
carts/{cartId}/estimate-shipping-methods-by-address-id
carts/{cartId}/gift-message
get
carts/{cartId}/gift-message
post
carts/{cartId}/gift-message
carts/{cartId}/gift-message/{itemId}
get
carts/{cartId}/gift-message/{itemId}
post
carts/{cartId}/gift-message/{itemId}
carts/{cartId}/giftCards
put
carts/{cartId}/giftCards
carts/{cartId}/giftCards/{giftCardCode}
del
carts/{cartId}/giftCards/{giftCardCode}
carts/{cartId}/items
get
carts/{cartId}/items
carts/{cartId}/items/{itemId}
put
carts/{cartId}/items/{itemId}
del
carts/{cartId}/items/{itemId}
carts/{cartId}/order
put
carts/{cartId}/order
carts/{cartId}/payment-methods
get
carts/{cartId}/payment-methods
carts/{cartId}/selected-payment-method
get
carts/{cartId}/selected-payment-method
put
carts/{cartId}/selected-payment-method
carts/{cartId}/shipping-information
post
carts/{cartId}/shipping-information
carts/{cartId}/shipping-methods
get
carts/{cartId}/shipping-methods
carts/{cartId}/totals
get
carts/{cartId}/totals
carts/{cartId}/totals-information
post
carts/{cartId}/totals-information
carts/{quoteId}/giftCards
get
carts/{quoteId}/giftCards
carts/{quoteId}/items
post
carts/{quoteId}/items
categories
categories
post
categories
get
categories
categories/attributes
get
categories/attributes
categories/attributes/{attributeCode}
get
categories/attributes/{attributeCode}
categories/attributes/{attributeCode}/options
get
categories/attributes/{attributeCode}/options
categories/list
get
categories/list
categories/{categoryId}
del
categories/{categoryId}
get
categories/{categoryId}
categories/{categoryId}/move
put
categories/{categoryId}/move
categories/{categoryId}/products
get
categories/{categoryId}/products
post
categories/{categoryId}/products
put
categories/{categoryId}/products
categories/{categoryId}/products/{sku}
del
categories/{categoryId}/products/{sku}
categories/{id}
put
categories/{id}
cmsBlock
cmsBlock
post
cmsBlock
cmsBlock/search
get
cmsBlock/search
cmsBlock/{blockId}
get
cmsBlock/{blockId}
del
cmsBlock/{blockId}
cmsBlock/{id}
put
cmsBlock/{id}
cmsPage
cmsPage
post
cmsPage
cmsPage/search
get
cmsPage/search
cmsPage/{id}
put
cmsPage/{id}
cmsPage/{pageId}
get
cmsPage/{pageId}
del
cmsPage/{pageId}
company
company/
get
company/
post
company/
company/assignRoles
put
company/assignRoles
company/role/
get
company/role/
post
company/role/
company/role/{id}
put
company/role/{id}
company/role/{roleId}
get
company/role/{roleId}
del
company/role/{roleId}
company/role/{roleId}/users
get
company/role/{roleId}/users
company/{companyId}
get
company/{companyId}
del
company/{companyId}
put
company/{companyId}
companyCredits
companyCredits/
get
companyCredits/
companyCredits/company/{companyId}
get
companyCredits/company/{companyId}
companyCredits/history
get
companyCredits/history
companyCredits/history/{historyId}
put
companyCredits/history/{historyId}
companyCredits/{creditId}
get
companyCredits/{creditId}
companyCredits/{creditId}/decreaseBalance
post
companyCredits/{creditId}/decreaseBalance
companyCredits/{creditId}/increaseBalance
post
companyCredits/{creditId}/increaseBalance
companyCredits/{id}
put
companyCredits/{id}
configurable products
configurable-products/variation
put
configurable-products/variation
configurable-products/{sku}/child
post
configurable-products/{sku}/child
configurable-products/{sku}/children
get
configurable-products/{sku}/children
configurable-products/{sku}/children/{childSku}
del
configurable-products/{sku}/children/{childSku}
configurable-products/{sku}/options
post
configurable-products/{sku}/options
configurable-products/{sku}/options/all
get
configurable-products/{sku}/options/all
configurable-products/{sku}/options/{id}
get
configurable-products/{sku}/options/{id}
put
configurable-products/{sku}/options/{id}
del
configurable-products/{sku}/options/{id}
coupons
coupons
post
coupons
coupons/deleteByCodes
post
coupons/deleteByCodes
coupons/deleteByIds
post
coupons/deleteByIds
coupons/generate
post
coupons/generate
coupons/search
get
coupons/search
coupons/{couponId}
get
coupons/{couponId}
put
coupons/{couponId}
del
coupons/{couponId}
creditmemo
creditmemo
post
creditmemo
creditmemo/refund
post
creditmemo/refund
creditmemo/{id}
put
creditmemo/{id}
get
creditmemo/{id}
creditmemo/{id}/comments
get
creditmemo/{id}/comments
post
creditmemo/{id}/comments
creditmemo/{id}/emails
post
creditmemo/{id}/emails
creditmemos
creditmemos
get
creditmemos
customerGroups
customerGroups
post
customerGroups
customerGroups/default
get
customerGroups/default
customerGroups/default/{id}
put
customerGroups/default/{id}
customerGroups/default/{storeId}
get
customerGroups/default/{storeId}
customerGroups/search
get
customerGroups/search
customerGroups/{id}
get
customerGroups/{id}
put
customerGroups/{id}
del
customerGroups/{id}
customerGroups/{id}/permissions
get
customerGroups/{id}/permissions
customers
customers
post
customers
customers/addresses/{addressId}
get
customers/addresses/{addressId}
customers/confirm
post
customers/confirm
customers/isEmailAvailable
post
customers/isEmailAvailable
customers/me
put
customers/me
get
customers/me
customers/me/activate
put
customers/me/activate
customers/me/billingAddress
get
customers/me/billingAddress
customers/me/password
put
customers/me/password
customers/me/shippingAddress
get
customers/me/shippingAddress
customers/password
put
customers/password
customers/resetPassword
post
customers/resetPassword
customers/search
get
customers/search
customers/validate
put
customers/validate
customers/{customerId}
get
customers/{customerId}
put
customers/{customerId}
del
customers/{customerId}
customers/{customerId}/billingAddress
get
customers/{customerId}/billingAddress
customers/{customerId}/carts
post
customers/{customerId}/carts
customers/{customerId}/confirm
get
customers/{customerId}/confirm
customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
get
customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
customers/{customerId}/permissions/readonly
get
customers/{customerId}/permissions/readonly
customers/{customerId}/shippingAddress
get
customers/{customerId}/shippingAddress
customers/{email}/activate
put
customers/{email}/activate
directory
directory/countries
get
directory/countries
directory/countries/{countryId}
get
directory/countries/{countryId}
directory/currency
get
directory/currency
eav
eav/attribute-sets
post
eav/attribute-sets
eav/attribute-sets/list
get
eav/attribute-sets/list
eav/attribute-sets/{attributeSetId}
get
eav/attribute-sets/{attributeSetId}
del
eav/attribute-sets/{attributeSetId}
put
eav/attribute-sets/{attributeSetId}
eventing
eventing/eventSubscribe
post
eventing/eventSubscribe
eventing/updateConfiguration
put
eventing/updateConfiguration
gift wrappings
gift-wrappings
post
gift-wrappings
get
gift-wrappings
gift-wrappings/{id}
get
gift-wrappings/{id}
del
gift-wrappings/{id}
gift-wrappings/{wrappingId}
put
gift-wrappings/{wrappingId}
giftregistry
giftregistry/mine/estimate-shipping-methods
post
giftregistry/mine/estimate-shipping-methods
guest carts
guest-carts
post
guest-carts
guest-carts/{cartId}
get
guest-carts/{cartId}
put
guest-carts/{cartId}
guest-carts/{cartId}/billing-address
get
guest-carts/{cartId}/billing-address
post
guest-carts/{cartId}/billing-address
guest-carts/{cartId}/collect-totals
put
guest-carts/{cartId}/collect-totals
guest-carts/{cartId}/coupons
get
guest-carts/{cartId}/coupons
del
guest-carts/{cartId}/coupons
guest-carts/{cartId}/coupons/{couponCode}
put
guest-carts/{cartId}/coupons/{couponCode}
guest-carts/{cartId}/estimate-shipping-methods
post
guest-carts/{cartId}/estimate-shipping-methods
guest-carts/{cartId}/gift-message
get
guest-carts/{cartId}/gift-message
post
guest-carts/{cartId}/gift-message
guest-carts/{cartId}/gift-message/{itemId}
get
guest-carts/{cartId}/gift-message/{itemId}
post
guest-carts/{cartId}/gift-message/{itemId}
guest-carts/{cartId}/items
get
guest-carts/{cartId}/items
post
guest-carts/{cartId}/items
guest-carts/{cartId}/items/{itemId}
put
guest-carts/{cartId}/items/{itemId}
del
guest-carts/{cartId}/items/{itemId}
guest-carts/{cartId}/order
put
guest-carts/{cartId}/order
guest-carts/{cartId}/payment-information
post
guest-carts/{cartId}/payment-information
get
guest-carts/{cartId}/payment-information
guest-carts/{cartId}/payment-methods
get
guest-carts/{cartId}/payment-methods
guest-carts/{cartId}/payment-order
post
guest-carts/{cartId}/payment-order
guest-carts/{cartId}/payment-order/{id}
get
guest-carts/{cartId}/payment-order/{id}
post
guest-carts/{cartId}/payment-order/{id}
guest-carts/{cartId}/selected-payment-method
get
guest-carts/{cartId}/selected-payment-method
put
guest-carts/{cartId}/selected-payment-method
guest-carts/{cartId}/set-payment-information
post
guest-carts/{cartId}/set-payment-information
guest-carts/{cartId}/shipping-information
post
guest-carts/{cartId}/shipping-information
guest-carts/{cartId}/shipping-methods
get
guest-carts/{cartId}/shipping-methods
guest-carts/{cartId}/totals
get
guest-carts/{cartId}/totals
guest-carts/{cartId}/totals-information
post
guest-carts/{cartId}/totals-information
guest giftregistry
guest-giftregistry/{cartId}/estimate-shipping-methods
post
guest-giftregistry/{cartId}/estimate-shipping-methods
hierarchy
hierarchy/move/{id}
put
hierarchy/move/{id}
hierarchy/{id}
get
hierarchy/{id}
import
import/csv
post
import/csv
import/json
post
import/json
integration
integration/admin/token
post
integration/admin/token
integration/customer/revoke-customer-token
post
integration/customer/revoke-customer-token
integration/customer/token
post
integration/customer/token
inventory
inventory/are-product-salable-for-requested-qty/
get
inventory/are-product-salable-for-requested-qty/
inventory/are-products-salable
get
inventory/are-products-salable
inventory/bulk-partial-source-transfer
post
inventory/bulk-partial-source-transfer
inventory/bulk-product-source-assign
post
inventory/bulk-product-source-assign
inventory/bulk-product-source-transfer
post
inventory/bulk-product-source-transfer
inventory/bulk-product-source-unassign
post
inventory/bulk-product-source-unassign
inventory/dump-stock-index-data/{salesChannelType}/{salesChannelCode}
get
inventory/dump-stock-index-data/{salesChannelType}/{salesChannelCode}
inventory/export-stock-salable-qty/{salesChannelType}/{salesChannelCode}
get
inventory/export-stock-salable-qty/{salesChannelType}/{salesChannelCode}
inventory/get-distance
get
inventory/get-distance
inventory/get-distance-provider-code
get
inventory/get-distance-provider-code
inventory/get-latlng-from-address
get
inventory/get-latlng-from-address
inventory/get-latslngs-from-address
get
inventory/get-latslngs-from-address
inventory/get-product-salable-quantity/{sku}/{stockId}
get
inventory/get-product-salable-quantity/{sku}/{stockId}
inventory/get-sources-assigned-to-stock-ordered-by-priority/{stockId}
get
inventory/get-sources-assigned-to-stock-ordered-by-priority/{stockId}
inventory/in-store-pickup/pickup-locations/
get
inventory/in-store-pickup/pickup-locations/
inventory/is-product-salable-for-requested-qty/{sku}/{stockId}/{requestedQty}
get
inventory/is-product-salable-for-requested-qty/{sku}/{stockId}/{requestedQty}
inventory/is-product-salable/{sku}/{stockId}
get
inventory/is-product-salable/{sku}/{stockId}
inventory/low-quantity-notification
post
inventory/low-quantity-notification
inventory/low-quantity-notification/{sourceCode}/{sku}
get
inventory/low-quantity-notification/{sourceCode}/{sku}
inventory/low-quantity-notifications-delete
post
inventory/low-quantity-notifications-delete
inventory/source-items
get
inventory/source-items
post
inventory/source-items
inventory/source-items-delete
post
inventory/source-items-delete
inventory/source-selection-algorithm-list
get
inventory/source-selection-algorithm-list
inventory/source-selection-algorithm-result
post
inventory/source-selection-algorithm-result
inventory/sources
get
inventory/sources
post
inventory/sources
inventory/sources/{sourceCode}
get
inventory/sources/{sourceCode}
put
inventory/sources/{sourceCode}
inventory/stock-resolver/{type}/{code}
get
inventory/stock-resolver/{type}/{code}
inventory/stock-source-links
get
inventory/stock-source-links
post
inventory/stock-source-links
inventory/stock-source-links-delete
post
inventory/stock-source-links-delete
inventory/stocks
get
inventory/stocks
post
inventory/stocks
inventory/stocks/{stockId}
get
inventory/stocks/{stockId}
del
inventory/stocks/{stockId}
put
inventory/stocks/{stockId}
invoice
invoice/{invoiceId}/refund
post
invoice/{invoiceId}/refund
invoices
invoices
get
invoices
invoices/
post
invoices/
invoices/comments
post
invoices/comments
invoices/{id}
get
invoices/{id}
invoices/{id}/capture
post
invoices/{id}/capture
invoices/{id}/comments
get
invoices/{id}/comments
invoices/{id}/emails
post
invoices/{id}/emails
invoices/{id}/void
post
invoices/{id}/void
modules
modules
get
modules
negotiable cart item note
negotiable-cart-item-note
post
negotiable-cart-item-note
negotiable-cart-item-note/search
get
negotiable-cart-item-note/search
negotiable-cart-item-note/{noteId}
get
negotiable-cart-item-note/{noteId}
del
negotiable-cart-item-note/{noteId}
negotiable carts
negotiable-carts/{cartId}/billing-address
get
negotiable-carts/{cartId}/billing-address
post
negotiable-carts/{cartId}/billing-address
negotiable-carts/{cartId}/coupons
del
negotiable-carts/{cartId}/coupons
negotiable-carts/{cartId}/coupons/{couponCode}
put
negotiable-carts/{cartId}/coupons/{couponCode}
negotiable-carts/{cartId}/estimate-shipping-methods
post
negotiable-carts/{cartId}/estimate-shipping-methods
negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id
post
negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id
negotiable-carts/{cartId}/giftCards
post
negotiable-carts/{cartId}/giftCards
negotiable-carts/{cartId}/giftCards/{giftCardCode}
del
negotiable-carts/{cartId}/giftCards/{giftCardCode}
negotiable-carts/{cartId}/payment-information
post
negotiable-carts/{cartId}/payment-information
get
negotiable-carts/{cartId}/payment-information
negotiable-carts/{cartId}/set-payment-information
post
negotiable-carts/{cartId}/set-payment-information
negotiable-carts/{cartId}/shipping-information
post
negotiable-carts/{cartId}/shipping-information
negotiable-carts/{cartId}/totals
get
negotiable-carts/{cartId}/totals
negotiableQuote
negotiableQuote/attachmentContent
get
negotiableQuote/attachmentContent
negotiableQuote/decline
post
negotiableQuote/decline
negotiableQuote/draft
post
negotiableQuote/draft
negotiableQuote/pricesUpdated
post
negotiableQuote/pricesUpdated
negotiableQuote/request
post
negotiableQuote/request
negotiableQuote/submitToCustomer
post
negotiableQuote/submitToCustomer
negotiableQuote/{quoteId}
put
negotiableQuote/{quoteId}
negotiableQuote/{quoteId}/comments
get
negotiableQuote/{quoteId}/comments
negotiableQuote/{quoteId}/shippingMethod
put
negotiableQuote/{quoteId}/shippingMethod
order
order/notify-orders-are-ready-for-pickup
post
order/notify-orders-are-ready-for-pickup
order/{orderId}/invoice
post
order/{orderId}/invoice
order/{orderId}/refund
post
order/{orderId}/refund
order/{orderId}/ship
post
order/{orderId}/ship
orders
orders
get
orders
post
orders
orders/create
put
orders/create
orders/items
get
orders/items
orders/items/{id}
get
orders/items/{id}
orders/{id}
get
orders/{id}
orders/{id}/cancel
post
orders/{id}/cancel
orders/{id}/comments
post
orders/{id}/comments
get
orders/{id}/comments
orders/{id}/emails
post
orders/{id}/emails
orders/{id}/hold
post
orders/{id}/hold
orders/{id}/statuses
get
orders/{id}/statuses
orders/{id}/unhold
post
orders/{id}/unhold
orders/{parent_id}
put
orders/{parent_id}
payments config
payments-config/apple-pay/{location}
get
payments-config/apple-pay/{location}
payments-config/hosted-fields/{location}
get
payments-config/hosted-fields/{location}
payments-config/smart-buttons/{location}
get
payments-config/smart-buttons/{location}
payments-config/{location}
get
payments-config/{location}
payments sdk
payments-sdk/{location}
get
payments-sdk/{location}
payments-sdk/{location}/{methodCode}
get
payments-sdk/{location}/{methodCode}
products
products
post
products
get
products
products/attribute-sets
post
products/attribute-sets
products/attribute-sets/attributes
post
products/attribute-sets/attributes
products/attribute-sets/groups
post
products/attribute-sets/groups
products/attribute-sets/groups/list
get
products/attribute-sets/groups/list
products/attribute-sets/groups/{groupId}
del
products/attribute-sets/groups/{groupId}
products/attribute-sets/sets/list
get
products/attribute-sets/sets/list
products/attribute-sets/{attributeSetId}
get
products/attribute-sets/{attributeSetId}
del
products/attribute-sets/{attributeSetId}
put
products/attribute-sets/{attributeSetId}
products/attribute-sets/{attributeSetId}/attributes
get
products/attribute-sets/{attributeSetId}/attributes
products/attribute-sets/{attributeSetId}/attributes/{attributeCode}
del
products/attribute-sets/{attributeSetId}/attributes/{attributeCode}
products/attribute-sets/{attributeSetId}/groups
put
products/attribute-sets/{attributeSetId}/groups
products/attributes
get
products/attributes
post
products/attributes
products/attributes/types
get
products/attributes/types
products/attributes/{attributeCode}
get
products/attributes/{attributeCode}
put
products/attributes/{attributeCode}
del
products/attributes/{attributeCode}
products/attributes/{attributeCode}/is-filterable
get
products/attributes/{attributeCode}/is-filterable
products/attributes/{attributeCode}/is-filterable/{isFilterable}
put
products/attributes/{attributeCode}/is-filterable/{isFilterable}
products/attributes/{attributeCode}/options
get
products/attributes/{attributeCode}/options
post
products/attributes/{attributeCode}/options
products/attributes/{attributeCode}/options/{optionId}
del
products/attributes/{attributeCode}/options/{optionId}
put
products/attributes/{attributeCode}/options/{optionId}
products/base-prices
post
products/base-prices
products/base-prices-information
post
products/base-prices-information
products/cost
post
products/cost
products/cost-delete
post
products/cost-delete
products/cost-information
post
products/cost-information
products/downloadable-links/samples/{id}
del
products/downloadable-links/samples/{id}
products/downloadable-links/{id}
del
products/downloadable-links/{id}
products/links/types
get
products/links/types
products/links/{type}/attributes
get
products/links/{type}/attributes
products/media/types/{attributeSetName}
get
products/media/types/{attributeSetName}
products/options
post
products/options
products/options/types
get
products/options/types
products/options/{optionId}
put
products/options/{optionId}
products/special-price
post
products/special-price
products/special-price-delete
post
products/special-price-delete
products/special-price-information
post
products/special-price-information
products/tier-prices
post
products/tier-prices
put
products/tier-prices
products/tier-prices-delete
post
products/tier-prices-delete
products/tier-prices-information
post
products/tier-prices-information
products/types
get
products/types
products/{productSku}/stockItems/{itemId}
put
products/{productSku}/stockItems/{itemId}
products/{sku}
put
products/{sku}
del
products/{sku}
get
products/{sku}
products/{sku}/downloadable-links
get
products/{sku}/downloadable-links
post
products/{sku}/downloadable-links
products/{sku}/downloadable-links/samples
get
products/{sku}/downloadable-links/samples
post
products/{sku}/downloadable-links/samples
products/{sku}/downloadable-links/samples/{id}
put
products/{sku}/downloadable-links/samples/{id}
products/{sku}/downloadable-links/{id}
put
products/{sku}/downloadable-links/{id}
products/{sku}/group-prices/{customerGroupId}/tiers
get
products/{sku}/group-prices/{customerGroupId}/tiers
products/{sku}/group-prices/{customerGroupId}/tiers/{qty}
del
products/{sku}/group-prices/{customerGroupId}/tiers/{qty}
products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}
post
products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}
products/{sku}/links
post
products/{sku}/links
put
products/{sku}/links
products/{sku}/links/{type}
get
products/{sku}/links/{type}
products/{sku}/links/{type}/{linkedProductSku}
del
products/{sku}/links/{type}/{linkedProductSku}
products/{sku}/media
post
products/{sku}/media
get
products/{sku}/media
products/{sku}/media/{entryId}
get
products/{sku}/media/{entryId}
put
products/{sku}/media/{entryId}
del
products/{sku}/media/{entryId}
products/{sku}/options
get
products/{sku}/options
products/{sku}/options/{optionId}
get
products/{sku}/options/{optionId}
del
products/{sku}/options/{optionId}
products/{sku}/websites
post
products/{sku}/websites
put
products/{sku}/websites
products/{sku}/websites/{websiteId}
del
products/{sku}/websites/{websiteId}
products render info
products-render-info
get
products-render-info
purchase order carts
purchase-order-carts/{cartId}/billing-address
post
purchase-order-carts/{cartId}/billing-address
purchase-order-carts/{cartId}/estimate-shipping-methods
post
purchase-order-carts/{cartId}/estimate-shipping-methods
purchase-order-carts/{cartId}/estimate-shipping-methods-by-address-id
post
purchase-order-carts/{cartId}/estimate-shipping-methods-by-address-id
purchase-order-carts/{cartId}/giftCards
post
purchase-order-carts/{cartId}/giftCards
purchase-order-carts/{cartId}/giftCards/{giftCardCode}
del
purchase-order-carts/{cartId}/giftCards/{giftCardCode}
purchase-order-carts/{cartId}/payment-information
post
purchase-order-carts/{cartId}/payment-information
get
purchase-order-carts/{cartId}/payment-information
purchase-order-carts/{cartId}/set-payment-information
post
purchase-order-carts/{cartId}/set-payment-information
purchase-order-carts/{cartId}/totals
get
purchase-order-carts/{cartId}/totals
requisition_lists
requisition_lists
post
requisition_lists
returns
returns
post
returns
get
returns
returns/{id}
get
returns/{id}
del
returns/{id}
put
returns/{id}
returns/{id}/comments
post
returns/{id}/comments
get
returns/{id}/comments
returns/{id}/labels
get
returns/{id}/labels
returns/{id}/tracking-numbers
post
returns/{id}/tracking-numbers
get
returns/{id}/tracking-numbers
returns/{id}/tracking-numbers/{trackId}
del
returns/{id}/tracking-numbers/{trackId}
returnsAttributeMetadata
returnsAttributeMetadata
get
returnsAttributeMetadata
returnsAttributeMetadata/custom
get
returnsAttributeMetadata/custom
returnsAttributeMetadata/form/{formCode}
get
returnsAttributeMetadata/form/{formCode}
returnsAttributeMetadata/{attributeCode}
get
returnsAttributeMetadata/{attributeCode}
reward
reward/mine/use-reward
post
reward/mine/use-reward
salesRules
salesRules
post
salesRules
salesRules/search
get
salesRules/search
salesRules/{ruleId}
get
salesRules/{ruleId}
put
salesRules/{ruleId}
del
salesRules/{ruleId}
search
search
get
search
sharedCatalog
sharedCatalog
post
sharedCatalog
sharedCatalog/
get
sharedCatalog/
sharedCatalog/{id}
put
sharedCatalog/{id}
sharedCatalog/{id}/assignCategories
post
sharedCatalog/{id}/assignCategories
sharedCatalog/{id}/assignProducts
post
sharedCatalog/{id}/assignProducts
sharedCatalog/{id}/categories
get
sharedCatalog/{id}/categories
sharedCatalog/{id}/products
get
sharedCatalog/{id}/products
sharedCatalog/{id}/unassignCategories
post
sharedCatalog/{id}/unassignCategories
sharedCatalog/{id}/unassignProducts
post
sharedCatalog/{id}/unassignProducts
sharedCatalog/{sharedCatalogId}
get
sharedCatalog/{sharedCatalogId}
del
sharedCatalog/{sharedCatalogId}
sharedCatalog/{sharedCatalogId}/assignCompanies
post
sharedCatalog/{sharedCatalogId}/assignCompanies
sharedCatalog/{sharedCatalogId}/assignTierPrices
post
sharedCatalog/{sharedCatalogId}/assignTierPrices
sharedCatalog/{sharedCatalogId}/companies
get
sharedCatalog/{sharedCatalogId}/companies
sharedCatalog/{sharedCatalogId}/resetTierPrices
post
sharedCatalog/{sharedCatalogId}/resetTierPrices
sharedCatalog/{sharedCatalogId}/unassignCompanies
post
sharedCatalog/{sharedCatalogId}/unassignCompanies
shipment
shipment/
post
shipment/
shipment/track
post
shipment/track
shipment/track/{id}
del
shipment/track/{id}
shipment/{id}
get
shipment/{id}
shipment/{id}/comments
get
shipment/{id}/comments
post
shipment/{id}/comments
shipment/{id}/emails
post
shipment/{id}/emails
shipment/{id}/label
get
shipment/{id}/label
shipments
shipments
get
shipments
stockItems
stockItems/lowStock/
get
stockItems/lowStock/
stockItems/{productSku}
get
stockItems/{productSku}
stockStatuses
stockStatuses/{productSku}
get
stockStatuses/{productSku}
store
store/storeConfigs
get
store/storeConfigs
store/storeGroups
get
store/storeGroups
store/storeViews
get
store/storeViews
store/websites
get
store/websites
taxClasses
taxClasses
post
taxClasses
taxClasses/search
get
taxClasses/search
taxClasses/{classId}
put
taxClasses/{classId}
taxClasses/{taxClassId}
get
taxClasses/{taxClassId}
del
taxClasses/{taxClassId}
taxRates
taxRates
post
taxRates
put
taxRates
taxRates/search
get
taxRates/search
taxRates/{rateId}
get
taxRates/{rateId}
del
taxRates/{rateId}
taxRules
taxRules
post
taxRules
put
taxRules
taxRules/search
get
taxRules/search
taxRules/{ruleId}
del
taxRules/{ruleId}
get
taxRules/{ruleId}
team
team/
get
team/
team/{companyId}
post
team/{companyId}
team/{teamId}
get
team/{teamId}
del
team/{teamId}
put
team/{teamId}
tfa
tfa/default-provider-code/{userId}
put
tfa/default-provider-code/{userId}
get
tfa/default-provider-code/{userId}
tfa/forced-providers
get
tfa/forced-providers
tfa/installed-providers
get
tfa/installed-providers
tfa/provider/authy/activate
post
tfa/provider/authy/activate
tfa/provider/authy/authenticate
post
tfa/provider/authy/authenticate
tfa/provider/authy/authenticate-onetouch
post
tfa/provider/authy/authenticate-onetouch
tfa/provider/authy/configure
post
tfa/provider/authy/configure
tfa/provider/authy/send-token/{via}
post
tfa/provider/authy/send-token/{via}
tfa/provider/duo_security/activate
post
tfa/provider/duo_security/activate
tfa/provider/duo_security/authenticate
post
tfa/provider/duo_security/authenticate
tfa/provider/duo_security/configure
post
tfa/provider/duo_security/configure
tfa/provider/duo_security/get-authentication-data
post
tfa/provider/duo_security/get-authentication-data
tfa/provider/google/activate
post
tfa/provider/google/activate
tfa/provider/google/authenticate
post
tfa/provider/google/authenticate
tfa/provider/google/configure
post
tfa/provider/google/configure
tfa/provider/u2fkey/activate
post
tfa/provider/u2fkey/activate
tfa/provider/u2fkey/authentication-challenge
post
tfa/provider/u2fkey/authentication-challenge
tfa/provider/u2fkey/configure
post
tfa/provider/u2fkey/configure
tfa/provider/u2fkey/verify
post
tfa/provider/u2fkey/verify
tfa/providers-to-activate/{userId}
get
tfa/providers-to-activate/{userId}
tfa/tfat-providers-to-activate
get
tfa/tfat-providers-to-activate
tfa/tfat-user-providers
get
tfa/tfat-user-providers
tfa/user-providers/{userId}
get
tfa/user-providers/{userId}
put
tfa/user-providers/{userId}
transactions
transactions
get
transactions
transactions/{id}
get
transactions/{id}
products/{sku}/links/{type}/{linkedProductSku}
products/{sku}/links/{type}/{linkedProductSku}
delete
/V1/products/{sku}/links/{type}/{linkedProductSku}
Request
path Parameters
linkedProductSku
required
string
sku
required
string
type
required
string
Responses
200
200 Success.
400
400 Bad Request
401
401 Unauthorized
default
Unexpected error
Response samples
200
400
401
default
application/json
application/xml
application/json
Copy
true
➔ Next to
products/{sku}/media