Overview
- GET /V1/attributeMetadata/customer
- GET /V1/attributeMetadata/customer/attribute/{attributeCode}
- PARAMETERS /V1/attributeMetadata/customer/attribute/{attributeCode}
- GET /V1/attributeMetadata/customer/custom
- GET /V1/attributeMetadata/customer/form/{formCode}
- PARAMETERS /V1/attributeMetadata/customer/form/{formCode}
- GET /V1/attributeMetadata/customerAddress
- GET /V1/attributeMetadata/customerAddress/attribute/{attributeCode}
- PARAMETERS /V1/attributeMetadata/customerAddress/attribute/{attributeCode}
- GET /V1/attributeMetadata/customerAddress/custom
- GET /V1/attributeMetadata/customerAddress/form/{formCode}
- PARAMETERS /V1/attributeMetadata/customerAddress/form/{formCode}
- POST /V1/bundle-products/options/add
- GET /V1/bundle-products/options/types
- PUT /V1/bundle-products/options/{optionId}
- PARAMETERS /V1/bundle-products/options/{optionId}
- PUT /V1/bundle-products/{sku}/links/{id}
- PARAMETERS /V1/bundle-products/{sku}/links/{id}
- POST /V1/bundle-products/{sku}/links/{optionId}
- PARAMETERS /V1/bundle-products/{sku}/links/{optionId}
- GET /V1/bundle-products/{sku}/options/{optionId}
- DELETE /V1/bundle-products/{sku}/options/{optionId}
- PARAMETERS /V1/bundle-products/{sku}/options/{optionId}
- DELETE /V1/bundle-products/{sku}/options/{optionId}/children/{childSku}
- PARAMETERS /V1/bundle-products/{sku}/options/{optionId}/children/{childSku}
- GET /V1/bundle-products/{sku}/options/all
- PARAMETERS /V1/bundle-products/{sku}/options/all
- GET /V1/bundle-products/{productSku}/children
- PARAMETERS /V1/bundle-products/{productSku}/children
- POST /V1/carts/guest-carts/{cartId}/giftCards
- PARAMETERS /V1/carts/guest-carts/{cartId}/giftCards
- DELETE /V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}
- PARAMETERS /V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}
- GET /V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
- PARAMETERS /V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
- GET /V1/carts/mine/billing-address
- POST /V1/carts/mine/billing-address
- GET /V1/carts/mine/coupons
- DELETE /V1/carts/mine/coupons
- PUT /V1/carts/mine/coupons/{couponCode}
- PARAMETERS /V1/carts/mine/coupons/{couponCode}
- GET /V1/carts/mine/gift-message/{itemId}
- POST /V1/carts/mine/gift-message/{itemId}
- PARAMETERS /V1/carts/mine/gift-message/{itemId}
- GET /V1/carts/mine/gift-message
- POST /V1/carts/mine/gift-message
- POST /V1/carts/mine/giftCards
- DELETE /V1/carts/mine/giftCards/{giftCardCode}
- PARAMETERS /V1/carts/mine/giftCards/{giftCardCode}
- PUT /V1/carts/mine/items/{itemId}
- DELETE /V1/carts/mine/items/{itemId}
- PARAMETERS /V1/carts/mine/items/{itemId}
- GET /V1/carts/mine/items
- POST /V1/carts/mine/items
- GET /V1/carts/mine/payment-information
- POST /V1/carts/mine/payment-information
- GET /V1/carts/mine/selected-payment-method
- PUT /V1/carts/mine/selected-payment-method
- GET /V1/carts/mine
- PUT /V1/carts/mine
- POST /V1/carts/mine
- POST /V1/carts/mine/balance/apply
- GET /V1/carts/mine/checkGiftCard/{giftCardCode}
- PARAMETERS /V1/carts/mine/checkGiftCard/{giftCardCode}
- PUT /V1/carts/mine/collect-totals
- POST /V1/carts/mine/estimate-shipping-methods
- POST /V1/carts/mine/estimate-shipping-methods-by-address-id
- PUT /V1/carts/mine/order
- GET /V1/carts/mine/payment-methods
- POST /V1/carts/mine/set-payment-information
- POST /V1/carts/mine/shipping-information
- GET /V1/carts/mine/shipping-methods
- GET /V1/carts/mine/totals
- POST /V1/carts/mine/totals-information
- GET /V1/carts/{cartId}/billing-address
- POST /V1/carts/{cartId}/billing-address
- PARAMETERS /V1/carts/{cartId}/billing-address
- GET /V1/carts/{cartId}/coupons
- DELETE /V1/carts/{cartId}/coupons
- PARAMETERS /V1/carts/{cartId}/coupons
- PUT /V1/carts/{cartId}/coupons/{couponCode}
- PARAMETERS /V1/carts/{cartId}/coupons/{couponCode}
- GET /V1/carts/{cartId}/gift-message/{itemId}
- POST /V1/carts/{cartId}/gift-message/{itemId}
- PARAMETERS /V1/carts/{cartId}/gift-message/{itemId}
- GET /V1/carts/{cartId}/gift-message
- POST /V1/carts/{cartId}/gift-message
- PARAMETERS /V1/carts/{cartId}/gift-message
- PUT /V1/carts/{cartId}/giftCards
- PARAMETERS /V1/carts/{cartId}/giftCards
- DELETE /V1/carts/{cartId}/giftCards/{giftCardCode}
- PARAMETERS /V1/carts/{cartId}/giftCards/{giftCardCode}
- PUT /V1/carts/{cartId}/items/{itemId}
- DELETE /V1/carts/{cartId}/items/{itemId}
- PARAMETERS /V1/carts/{cartId}/items/{itemId}
- GET /V1/carts/{cartId}/items
- PARAMETERS /V1/carts/{cartId}/items
- GET /V1/carts/{cartId}/selected-payment-method
- PUT /V1/carts/{cartId}/selected-payment-method
- PARAMETERS /V1/carts/{cartId}/selected-payment-method
- GET /V1/carts/{cartId}
- PUT /V1/carts/{cartId}
- PARAMETERS /V1/carts/{cartId}
- POST /V1/carts/{cartId}/estimate-shipping-methods
- PARAMETERS /V1/carts/{cartId}/estimate-shipping-methods
- POST /V1/carts/{cartId}/estimate-shipping-methods-by-address-id
- PARAMETERS /V1/carts/{cartId}/estimate-shipping-methods-by-address-id
- PUT /V1/carts/{cartId}/order
- PARAMETERS /V1/carts/{cartId}/order
- GET /V1/carts/{cartId}/payment-methods
- PARAMETERS /V1/carts/{cartId}/payment-methods
- POST /V1/carts/{cartId}/shipping-information
- PARAMETERS /V1/carts/{cartId}/shipping-information
- GET /V1/carts/{cartId}/shipping-methods
- PARAMETERS /V1/carts/{cartId}/shipping-methods
- GET /V1/carts/{cartId}/totals
- PARAMETERS /V1/carts/{cartId}/totals
- POST /V1/carts/{cartId}/totals-information
- PARAMETERS /V1/carts/{cartId}/totals-information
- GET /V1/carts/{quoteId}/giftCards
- PARAMETERS /V1/carts/{quoteId}/giftCards
- POST /V1/carts/{quoteId}/items
- PARAMETERS /V1/carts/{quoteId}/items
- POST /V1/carts/
- GET /V1/carts/licence
- GET /V1/carts/search
- GET /V1/categories/attributes/{attributeCode}
- PARAMETERS /V1/categories/attributes/{attributeCode}
- GET /V1/categories/attributes/{attributeCode}/options
- PARAMETERS /V1/categories/attributes/{attributeCode}/options
- GET /V1/categories/attributes
- GET /V1/categories/{categoryId}/products
- PUT /V1/categories/{categoryId}/products
- POST /V1/categories/{categoryId}/products
- PARAMETERS /V1/categories/{categoryId}/products
- DELETE /V1/categories/{categoryId}/products/{sku}
- PARAMETERS /V1/categories/{categoryId}/products/{sku}
- GET /V1/categories/{categoryId}
- DELETE /V1/categories/{categoryId}
- PARAMETERS /V1/categories/{categoryId}
- PUT /V1/categories/{categoryId}/move
- PARAMETERS /V1/categories/{categoryId}/move
- GET /V1/categories
- POST /V1/categories
- PUT /V1/categories/{id}
- PARAMETERS /V1/categories/{id}
- GET /V1/cmsBlock/{blockId}
- DELETE /V1/cmsBlock/{blockId}
- PARAMETERS /V1/cmsBlock/{blockId}
- POST /V1/cmsBlock
- GET /V1/cmsBlock/search
- PUT /V1/cmsBlock/{id}
- PARAMETERS /V1/cmsBlock/{id}
- GET /V1/cmsPage/{pageId}
- DELETE /V1/cmsPage/{pageId}
- PARAMETERS /V1/cmsPage/{pageId}
- POST /V1/cmsPage
- GET /V1/cmsPage/search
- PUT /V1/cmsPage/{id}
- PARAMETERS /V1/cmsPage/{id}
- GET /V1/configurable-products/{sku}/children
- PARAMETERS /V1/configurable-products/{sku}/children
- DELETE /V1/configurable-products/{sku}/children/{childSku}
- PARAMETERS /V1/configurable-products/{sku}/children/{childSku}
- GET /V1/configurable-products/{sku}/options/{id}
- PUT /V1/configurable-products/{sku}/options/{id}
- DELETE /V1/configurable-products/{sku}/options/{id}
- PARAMETERS /V1/configurable-products/{sku}/options/{id}
- POST /V1/configurable-products/{sku}/options
- PARAMETERS /V1/configurable-products/{sku}/options
- GET /V1/configurable-products/{sku}/options/all
- PARAMETERS /V1/configurable-products/{sku}/options/all
- POST /V1/configurable-products/{sku}/child
- PARAMETERS /V1/configurable-products/{sku}/child
- PUT /V1/configurable-products/variation
- GET /V1/coupons/{couponId}
- PUT /V1/coupons/{couponId}
- DELETE /V1/coupons/{couponId}
- PARAMETERS /V1/coupons/{couponId}
- POST /V1/coupons
- POST /V1/coupons/deleteByCodes
- POST /V1/coupons/deleteByIds
- POST /V1/coupons/generate
- GET /V1/coupons/search
- GET /V1/creditmemo/{id}/comments
- POST /V1/creditmemo/{id}/comments
- PARAMETERS /V1/creditmemo/{id}/comments
- GET /V1/creditmemo/{id}
- PUT /V1/creditmemo/{id}
- PARAMETERS /V1/creditmemo/{id}
- POST /V1/creditmemo/{id}/emails
- PARAMETERS /V1/creditmemo/{id}/emails
- POST /V1/creditmemo
- POST /V1/creditmemo/refund
- GET /V1/customerGroups/default
- GET /V1/customerGroups/default/{storeId}
- PARAMETERS /V1/customerGroups/default/{storeId}
- GET /V1/customerGroups/{id}
- PUT /V1/customerGroups/{id}
- DELETE /V1/customerGroups/{id}
- PARAMETERS /V1/customerGroups/{id}
- GET /V1/customerGroups/{id}/permissions
- PARAMETERS /V1/customerGroups/{id}/permissions
- POST /V1/customerGroups
- GET /V1/customerGroups/search
- GET /V1/customers/me
- PUT /V1/customers/me
- PUT /V1/customers/me/activate
- GET /V1/customers/me/billingAddress
- PUT /V1/customers/me/password
- GET /V1/customers/me/shippingAddress
- GET /V1/customers/{customerId}
- DELETE /V1/customers/{customerId}
- PARAMETERS /V1/customers/{customerId}
- GET /V1/customers/{customerId}/billingAddress
- PARAMETERS /V1/customers/{customerId}/billingAddress
- POST /V1/customers/{customerId}/carts
- PARAMETERS /V1/customers/{customerId}/carts
- GET /V1/customers/{customerId}/confirm
- PARAMETERS /V1/customers/{customerId}/confirm
- GET /V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
- PARAMETERS /V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
- GET /V1/customers/{customerId}/permissions/readonly
- PARAMETERS /V1/customers/{customerId}/permissions/readonly
- GET /V1/customers/{customerId}/shippingAddress
- PARAMETERS /V1/customers/{customerId}/shippingAddress
- POST /V1/customers
- GET /V1/customers/addresses/{addressId}
- PARAMETERS /V1/customers/addresses/{addressId}
- POST /V1/customers/confirm
- POST /V1/customers/isEmailAvailable
- PUT /V1/customers/password
- GET /V1/customers/search
- PUT /V1/customers/validate
- PUT /V1/customers/{email}/activate
- PARAMETERS /V1/customers/{email}/activate
- PUT /V1/customers/{id}
- PARAMETERS /V1/customers/{id}
- GET /V1/directory/countries
- GET /V1/directory/countries/{countryId}
- PARAMETERS /V1/directory/countries/{countryId}
- GET /V1/directory/currency
- GET /V1/eav/attribute-sets/{attributeSetId}
- PUT /V1/eav/attribute-sets/{attributeSetId}
- DELETE /V1/eav/attribute-sets/{attributeSetId}
- PARAMETERS /V1/eav/attribute-sets/{attributeSetId}
- POST /V1/eav/attribute-sets
- GET /V1/eav/attribute-sets/list
- GET /V1/gift-wrappings/{id}
- DELETE /V1/gift-wrappings/{id}
- PARAMETERS /V1/gift-wrappings/{id}
- GET /V1/gift-wrappings
- POST /V1/gift-wrappings
- PUT /V1/gift-wrappings/{wrappingId}
- PARAMETERS /V1/gift-wrappings/{wrappingId}
- GET /V1/guest-carts/{cartId}/billing-address
- POST /V1/guest-carts/{cartId}/billing-address
- PARAMETERS /V1/guest-carts/{cartId}/billing-address
- GET /V1/guest-carts/{cartId}/coupons
- DELETE /V1/guest-carts/{cartId}/coupons
- PARAMETERS /V1/guest-carts/{cartId}/coupons
- PUT /V1/guest-carts/{cartId}/coupons/{couponCode}
- PARAMETERS /V1/guest-carts/{cartId}/coupons/{couponCode}
- GET /V1/guest-carts/{cartId}/gift-message/{itemId}
- POST /V1/guest-carts/{cartId}/gift-message/{itemId}
- PARAMETERS /V1/guest-carts/{cartId}/gift-message/{itemId}
- GET /V1/guest-carts/{cartId}/gift-message
- POST /V1/guest-carts/{cartId}/gift-message
- PARAMETERS /V1/guest-carts/{cartId}/gift-message
- PUT /V1/guest-carts/{cartId}/items/{itemId}
- DELETE /V1/guest-carts/{cartId}/items/{itemId}
- PARAMETERS /V1/guest-carts/{cartId}/items/{itemId}
- GET /V1/guest-carts/{cartId}/items
- POST /V1/guest-carts/{cartId}/items
- PARAMETERS /V1/guest-carts/{cartId}/items
- GET /V1/guest-carts/{cartId}/payment-information
- POST /V1/guest-carts/{cartId}/payment-information
- PARAMETERS /V1/guest-carts/{cartId}/payment-information
- GET /V1/guest-carts/{cartId}/selected-payment-method
- PUT /V1/guest-carts/{cartId}/selected-payment-method
- PARAMETERS /V1/guest-carts/{cartId}/selected-payment-method
- GET /V1/guest-carts/{cartId}
- PUT /V1/guest-carts/{cartId}
- PARAMETERS /V1/guest-carts/{cartId}
- PUT /V1/guest-carts/{cartId}/collect-totals
- PARAMETERS /V1/guest-carts/{cartId}/collect-totals
- POST /V1/guest-carts/{cartId}/estimate-shipping-methods
- PARAMETERS /V1/guest-carts/{cartId}/estimate-shipping-methods
- PUT /V1/guest-carts/{cartId}/order
- PARAMETERS /V1/guest-carts/{cartId}/order
- GET /V1/guest-carts/{cartId}/payment-methods
- PARAMETERS /V1/guest-carts/{cartId}/payment-methods
- POST /V1/guest-carts/{cartId}/set-payment-information
- PARAMETERS /V1/guest-carts/{cartId}/set-payment-information
- POST /V1/guest-carts/{cartId}/shipping-information
- PARAMETERS /V1/guest-carts/{cartId}/shipping-information
- GET /V1/guest-carts/{cartId}/shipping-methods
- PARAMETERS /V1/guest-carts/{cartId}/shipping-methods
- GET /V1/guest-carts/{cartId}/totals
- PARAMETERS /V1/guest-carts/{cartId}/totals
- POST /V1/guest-carts/{cartId}/totals-information
- PARAMETERS /V1/guest-carts/{cartId}/totals-information
- POST /V1/guest-carts
- POST /V1/integration/admin/token
- POST /V1/integration/customer/token
- GET /V1/invoices/{id}
- PARAMETERS /V1/invoices/{id}
- POST /V1/invoices/{id}/capture
- PARAMETERS /V1/invoices/{id}/capture
- GET /V1/invoices/{id}/comments
- PARAMETERS /V1/invoices/{id}/comments
- POST /V1/invoices/{id}/emails
- PARAMETERS /V1/invoices/{id}/emails
- POST /V1/invoices/{id}/void
- PARAMETERS /V1/invoices/{id}/void
- GET /V1/invoices
- POST /V1/invoices/
- POST /V1/invoices/comments
- POST /V1/order/{orderId}/invoice
- PARAMETERS /V1/order/{orderId}/invoice
- POST /V1/order/{orderId}/refund
- PARAMETERS /V1/order/{orderId}/refund
- POST /V1/order/{orderId}/ship
- PARAMETERS /V1/order/{orderId}/ship
- GET /V1/orders/items
- GET /V1/orders/items/{id}
- PARAMETERS /V1/orders/items/{id}
- GET /V1/orders/{id}/comments
- POST /V1/orders/{id}/comments
- PARAMETERS /V1/orders/{id}/comments
- GET /V1/orders/{id}
- PARAMETERS /V1/orders/{id}
- POST /V1/orders/{id}/cancel
- PARAMETERS /V1/orders/{id}/cancel
- POST /V1/orders/{id}/emails
- PARAMETERS /V1/orders/{id}/emails
- POST /V1/orders/{id}/hold
- PARAMETERS /V1/orders/{id}/hold
- GET /V1/orders/{id}/statuses
- PARAMETERS /V1/orders/{id}/statuses
- POST /V1/orders/{id}/unhold
- PARAMETERS /V1/orders/{id}/unhold
- GET /V1/orders
- POST /V1/orders/
- PUT /V1/orders/create
- PUT /V1/orders/{parent_id}
- PARAMETERS /V1/orders/{parent_id}
- POST /V1/products/attribute-sets/groups
- GET /V1/products/attribute-sets/groups/list
- DELETE /V1/products/attribute-sets/groups/{groupId}
- PARAMETERS /V1/products/attribute-sets/groups/{groupId}
- GET /V1/products/attribute-sets/{attributeSetId}/attributes
- PARAMETERS /V1/products/attribute-sets/{attributeSetId}/attributes
- DELETE /V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}
- PARAMETERS /V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}
- GET /V1/products/attribute-sets/{attributeSetId}
- PUT /V1/products/attribute-sets/{attributeSetId}
- DELETE /V1/products/attribute-sets/{attributeSetId}
- PARAMETERS /V1/products/attribute-sets/{attributeSetId}
- PUT /V1/products/attribute-sets/{attributeSetId}/groups
- PARAMETERS /V1/products/attribute-sets/{attributeSetId}/groups
- POST /V1/products/attribute-sets
- POST /V1/products/attribute-sets/attributes
- GET /V1/products/attribute-sets/sets/list
- GET /V1/products/attributes/{attributeCode}/options
- POST /V1/products/attributes/{attributeCode}/options
- PARAMETERS /V1/products/attributes/{attributeCode}/options
- DELETE /V1/products/attributes/{attributeCode}/options/{optionId}
- PARAMETERS /V1/products/attributes/{attributeCode}/options/{optionId}
- GET /V1/products/attributes/{attributeCode}
- PUT /V1/products/attributes/{attributeCode}
- DELETE /V1/products/attributes/{attributeCode}
- PARAMETERS /V1/products/attributes/{attributeCode}
- GET /V1/products/attributes
- POST /V1/products/attributes
- GET /V1/products/attributes/types
- DELETE /V1/products/downloadable-links/samples/{id}
- PARAMETERS /V1/products/downloadable-links/samples/{id}
- DELETE /V1/products/downloadable-links/{id}
- PARAMETERS /V1/products/downloadable-links/{id}
- GET /V1/products/links/types
- GET /V1/products/links/{type}/attributes
- PARAMETERS /V1/products/links/{type}/attributes
- POST /V1/products/options
- GET /V1/products/options/types
- PUT /V1/products/options/{optionId}
- PARAMETERS /V1/products/options/{optionId}
- GET /V1/products/{sku}/downloadable-links/samples
- POST /V1/products/{sku}/downloadable-links/samples
- PARAMETERS /V1/products/{sku}/downloadable-links/samples
- PUT /V1/products/{sku}/downloadable-links/samples/{id}
- PARAMETERS /V1/products/{sku}/downloadable-links/samples/{id}
- GET /V1/products/{sku}/downloadable-links
- POST /V1/products/{sku}/downloadable-links
- PARAMETERS /V1/products/{sku}/downloadable-links
- PUT /V1/products/{sku}/downloadable-links/{id}
- PARAMETERS /V1/products/{sku}/downloadable-links/{id}
- DELETE /V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}
- PARAMETERS /V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}
- POST /V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}
- PARAMETERS /V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}
- GET /V1/products/{sku}/group-prices/{customerGroupId}/tiers
- PARAMETERS /V1/products/{sku}/group-prices/{customerGroupId}/tiers
- GET /V1/products/{sku}/links/{type}
- PARAMETERS /V1/products/{sku}/links/{type}
- DELETE /V1/products/{sku}/links/{type}/{linkedProductSku}
- PARAMETERS /V1/products/{sku}/links/{type}/{linkedProductSku}
- PUT /V1/products/{sku}/links
- POST /V1/products/{sku}/links
- PARAMETERS /V1/products/{sku}/links
- GET /V1/products/{sku}/media/{entryId}
- PUT /V1/products/{sku}/media/{entryId}
- DELETE /V1/products/{sku}/media/{entryId}
- PARAMETERS /V1/products/{sku}/media/{entryId}
- GET /V1/products/{sku}/media
- POST /V1/products/{sku}/media
- PARAMETERS /V1/products/{sku}/media
- GET /V1/products/{sku}/options/{optionId}
- DELETE /V1/products/{sku}/options/{optionId}
- PARAMETERS /V1/products/{sku}/options/{optionId}
- GET /V1/products/{sku}/options
- PARAMETERS /V1/products/{sku}/options
- PUT /V1/products/{sku}/websites
- POST /V1/products/{sku}/websites
- PARAMETERS /V1/products/{sku}/websites
- DELETE /V1/products/{sku}/websites/{websiteId}
- PARAMETERS /V1/products/{sku}/websites/{websiteId}
- GET /V1/products/{sku}
- PUT /V1/products/{sku}
- DELETE /V1/products/{sku}
- PARAMETERS /V1/products/{sku}
- GET /V1/products
- POST /V1/products
- GET /V1/products/media/types/{attributeSetName}
- PARAMETERS /V1/products/media/types/{attributeSetName}
- GET /V1/products/types
- PUT /V1/products/{productSku}/stockItems/{itemId}
- PARAMETERS /V1/products/{productSku}/stockItems/{itemId}
- GET /V1/returns/{id}/comments
- POST /V1/returns/{id}/comments
- PARAMETERS /V1/returns/{id}/comments
- GET /V1/returns/{id}/tracking-numbers
- POST /V1/returns/{id}/tracking-numbers
- PARAMETERS /V1/returns/{id}/tracking-numbers
- DELETE /V1/returns/{id}/tracking-numbers/{trackId}
- PARAMETERS /V1/returns/{id}/tracking-numbers/{trackId}
- GET /V1/returns/{id}
- PUT /V1/returns/{id}
- DELETE /V1/returns/{id}
- PARAMETERS /V1/returns/{id}
- GET /V1/returns/{id}/labels
- PARAMETERS /V1/returns/{id}/labels
- GET /V1/returns
- POST /V1/returns
- GET /V1/returnsAttributeMetadata
- GET /V1/returnsAttributeMetadata/custom
- GET /V1/returnsAttributeMetadata/form/{formCode}
- PARAMETERS /V1/returnsAttributeMetadata/form/{formCode}
- GET /V1/returnsAttributeMetadata/{attributeCode}
- PARAMETERS /V1/returnsAttributeMetadata/{attributeCode}
- GET /V1/salesRules/{ruleId}
- PUT /V1/salesRules/{ruleId}
- DELETE /V1/salesRules/{ruleId}
- PARAMETERS /V1/salesRules/{ruleId}
- POST /V1/salesRules
- GET /V1/salesRules/search
- POST /V1/shipment/track
- DELETE /V1/shipment/track/{id}
- PARAMETERS /V1/shipment/track/{id}
- GET /V1/shipment/{id}/comments
- POST /V1/shipment/{id}/comments
- PARAMETERS /V1/shipment/{id}/comments
- GET /V1/shipment/{id}
- PARAMETERS /V1/shipment/{id}
- POST /V1/shipment/{id}/emails
- PARAMETERS /V1/shipment/{id}/emails
- GET /V1/shipment/{id}/label
- PARAMETERS /V1/shipment/{id}/label
- POST /V1/shipment/
- GET /V1/stockItems/lowStock/
- GET /V1/stockItems/{productSku}
- PARAMETERS /V1/stockItems/{productSku}
- GET /V1/store/storeConfigs
- GET /V1/store/storeGroups
- GET /V1/store/storeViews
- GET /V1/store/websites
- GET /V1/taxClasses/{taxClassId}
- DELETE /V1/taxClasses/{taxClassId}
- PARAMETERS /V1/taxClasses/{taxClassId}
- POST /V1/taxClasses
- GET /V1/taxClasses/search
- PUT /V1/taxClasses/{classId}
- PARAMETERS /V1/taxClasses/{classId}
- GET /V1/taxRates/{rateId}
- DELETE /V1/taxRates/{rateId}
- PARAMETERS /V1/taxRates/{rateId}
- PUT /V1/taxRates
- POST /V1/taxRates
- GET /V1/taxRates/search
- GET /V1/taxRules/{ruleId}
- DELETE /V1/taxRules/{ruleId}
- PARAMETERS /V1/taxRules/{ruleId}
- PUT /V1/taxRules
- POST /V1/taxRules
- GET /V1/taxRules/search
- GET /V1/transactions
- GET /V1/transactions/{id}
- PARAMETERS /V1/transactions/{id}
- DELETE /V1/addresses/{addressId}
- PARAMETERS /V1/addresses/{addressId}
- GET /V1/creditmemos
- POST /V1/giftregistry/mine/estimate-shipping-methods
- POST /V1/guest-giftregistry/{cartId}/estimate-shipping-methods
- PARAMETERS /V1/guest-giftregistry/{cartId}/estimate-shipping-methods
- POST /V1/invoice/{invoiceId}/refund
- PARAMETERS /V1/invoice/{invoiceId}/refund
- GET /V1/modules
- POST /V1/reward/mine/use-reward
- GET /V1/search
- GET /V1/shipments
- GET /V1/stockStatuses/{productSku}
- PARAMETERS /V1/stockStatuses/{productSku}
- POST /V1/worldpay-guest-carts/{cartId}/payment-information
- PARAMETERS /V1/worldpay-guest-carts/{cartId}/payment-information
GET /V1/attributeMetadata/customer
Summary: customer Customer Metadata V1Get All Attributes Metadata Get
Get all attribute metadata.
OpenAPI snippet URL
GET /V1/attributeMetadata/customer/attribute/{attributeCode}
Summary: customer Customer Metadata V1Get Attribute Metadata Get
Retrieve attribute metadata.
OpenAPI snippet URL
PARAMETERS /V1/attributeMetadata/customer/attribute/{attributeCode}
OpenAPI snippet URL
GET /V1/attributeMetadata/customer/custom
Summary: customer Customer Metadata V1Get Custom Attributes Metadata Get
Get custom attributes metadata for the given data interface.
OpenAPI snippet URL
GET /V1/attributeMetadata/customer/form/{formCode}
Summary: customer Customer Metadata V1Get Attributes Get
Retrieve all attributes filtered by form code
OpenAPI snippet URL
PARAMETERS /V1/attributeMetadata/customer/form/{formCode}
OpenAPI snippet URL
GET /V1/attributeMetadata/customerAddress
Summary: customer Address Metadata V1Get All Attributes Metadata Get
Get all attribute metadata.
OpenAPI snippet URL
GET /V1/attributeMetadata/customerAddress/attribute/{attributeCode}
Summary: customer Address Metadata V1Get Attribute Metadata Get
Retrieve attribute metadata.
OpenAPI snippet URL
PARAMETERS /V1/attributeMetadata/customerAddress/attribute/{attributeCode}
OpenAPI snippet URL
GET /V1/attributeMetadata/customerAddress/custom
Summary: customer Address Metadata V1Get Custom Attributes Metadata Get
Get custom attributes metadata for the given data interface.
OpenAPI snippet URL
GET /V1/attributeMetadata/customerAddress/form/{formCode}
Summary: customer Address Metadata V1Get Attributes Get
Retrieve all attributes filtered by form code
OpenAPI snippet URL
PARAMETERS /V1/attributeMetadata/customerAddress/form/{formCode}
OpenAPI snippet URL
POST /V1/bundle-products/options/add
Summary: bundle Product Option Management V1Save Post
Add new option for bundle product
OpenAPI snippet URL
GET /V1/bundle-products/options/types
Summary: bundle Product Option Type List V1Get Items Get
Get all types for options for bundle products
OpenAPI snippet URL
PUT /V1/bundle-products/options/{optionId}
Summary: bundle Product Option Management V1Save Put
Add new option for bundle product
OpenAPI snippet URL
PARAMETERS /V1/bundle-products/options/{optionId}
OpenAPI snippet URL
PUT /V1/bundle-products/{sku}/links/{id}
Summary: bundle Product Link Management V1Save Child Put
bundle Product Link Management V1Save Child Put
OpenAPI snippet URL
PARAMETERS /V1/bundle-products/{sku}/links/{id}
OpenAPI snippet URL
POST /V1/bundle-products/{sku}/links/{optionId}
Summary: bundle Product Link Management V1Add Child By Product Sku Post
Add child product to specified Bundle option by product sku
OpenAPI snippet URL
PARAMETERS /V1/bundle-products/{sku}/links/{optionId}
OpenAPI snippet URL
GET /V1/bundle-products/{sku}/options/{optionId}
Summary: bundle Product Option Repository V1Get Get
Get option for bundle product
OpenAPI snippet URL
DELETE /V1/bundle-products/{sku}/options/{optionId}
Summary: bundle Product Option Repository V1Delete By Id Delete
Remove bundle option
OpenAPI snippet URL
PARAMETERS /V1/bundle-products/{sku}/options/{optionId}
OpenAPI snippet URL
DELETE /V1/bundle-products/{sku}/options/{optionId}/children/{childSku}
Summary: bundle Product Link Management V1Remove Child Delete
Remove product from Bundle product option
OpenAPI snippet URL
PARAMETERS /V1/bundle-products/{sku}/options/{optionId}/children/{childSku}
OpenAPI snippet URL
GET /V1/bundle-products/{sku}/options/all
Summary: bundle Product Option Repository V1Get List Get
Get all options for bundle product
OpenAPI snippet URL
PARAMETERS /V1/bundle-products/{sku}/options/all
OpenAPI snippet URL
GET /V1/bundle-products/{productSku}/children
Summary: bundle Product Link Management V1Get Children Get
Get all children for Bundle product
OpenAPI snippet URL
PARAMETERS /V1/bundle-products/{productSku}/children
OpenAPI snippet URL
POST /V1/carts/guest-carts/{cartId}/giftCards
Summary: gift Card Account Guest Gift Card Account Management V1Add Gift Card Post
gift Card Account Guest Gift Card Account Management V1Add Gift Card Post
OpenAPI snippet URL
PARAMETERS /V1/carts/guest-carts/{cartId}/giftCards
OpenAPI snippet URL
DELETE /V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}
Summary: gift Card Account Guest Gift Card Account Management V1Delete By Quote Id Delete
Remove GiftCard Account entity
OpenAPI snippet URL
PARAMETERS /V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}
OpenAPI snippet URL
GET /V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
Summary: gift Card Account Guest Gift Card Account Management V1Check Gift Card Get
gift Card Account Guest Gift Card Account Management V1Check Gift Card Get
OpenAPI snippet URL
PARAMETERS /V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
OpenAPI snippet URL
GET /V1/carts/mine/billing-address
Summary: /V1/carts/mine/billing-address
Returns the billing address for a specified quote.
OpenAPI snippet URL
POST /V1/carts/mine/billing-address
Summary: /V1/carts/mine/billing-address
Assigns a specified billing address to a specified cart.
OpenAPI snippet URL
GET /V1/carts/mine/coupons
Summary: /V1/carts/mine/coupons
Returns information for a coupon in a specified cart.
OpenAPI snippet URL
DELETE /V1/carts/mine/coupons
Summary: /V1/carts/mine/coupons
Deletes a coupon from a specified cart.
OpenAPI snippet URL
PUT /V1/carts/mine/coupons/{couponCode}
Summary: /V1/carts/mine/coupons/:couponCode
Adds a coupon by code to a specified cart.
OpenAPI snippet URL
PARAMETERS /V1/carts/mine/coupons/{couponCode}
OpenAPI snippet URL
GET /V1/carts/mine/gift-message/{itemId}
Summary: /V1/carts/mine/gift-message/:itemId
Return the gift message for a specified item in a specified shopping cart.
OpenAPI snippet URL
POST /V1/carts/mine/gift-message/{itemId}
Summary: /V1/carts/mine/gift-message/:itemId
Set the gift message for a specified item in a specified shopping cart.
OpenAPI snippet URL
PARAMETERS /V1/carts/mine/gift-message/{itemId}
OpenAPI snippet URL
GET /V1/carts/mine/gift-message
Summary: /V1/carts/mine/gift-message
Return the gift message for a specified order.
OpenAPI snippet URL
POST /V1/carts/mine/gift-message
Summary: /V1/carts/mine/gift-message
Set the gift message for an entire order.
OpenAPI snippet URL
POST /V1/carts/mine/giftCards
Summary: gift Card Account Gift Card Account Management V1Save By Quote Id Post
gift Card Account Gift Card Account Management V1Save By Quote Id Post
OpenAPI snippet URL
DELETE /V1/carts/mine/giftCards/{giftCardCode}
Summary: /V1/carts/mine/giftCards/:giftCardCode
Remove GiftCard Account entity
OpenAPI snippet URL
PARAMETERS /V1/carts/mine/giftCards/{giftCardCode}
OpenAPI snippet URL
PUT /V1/carts/mine/items/{itemId}
Summary: /V1/carts/mine/items/:itemId
Add/update the specified cart item.
OpenAPI snippet URL
DELETE /V1/carts/mine/items/{itemId}
Summary: /V1/carts/mine/items/:itemId
Removes the specified item from the specified cart.
OpenAPI snippet URL
PARAMETERS /V1/carts/mine/items/{itemId}
OpenAPI snippet URL
GET /V1/carts/mine/items
Summary: /V1/carts/mine/items
Lists items that are assigned to a specified cart.
OpenAPI snippet URL
POST /V1/carts/mine/items
Summary: /V1/carts/mine/items
Add/update the specified cart item.
OpenAPI snippet URL
GET /V1/carts/mine/payment-information
Summary: checkout Payment Information Management V1Get Payment Information Get
Get payment information
OpenAPI snippet URL
POST /V1/carts/mine/payment-information
Summary: checkout Payment Information Management V1Save Payment Information And Place Order Post
Set payment information and place order for a specified cart.
OpenAPI snippet URL
GET /V1/carts/mine/selected-payment-method
Summary: /V1/carts/mine/selected-payment-method
Returns the payment method for a specified shopping cart.
OpenAPI snippet URL
PUT /V1/carts/mine/selected-payment-method
Summary: /V1/carts/mine/selected-payment-method
Adds a specified payment method to a specified shopping cart.
OpenAPI snippet URL
GET /V1/carts/mine
Summary: quote Cart Management V1Get Cart For Customer Get
Returns information for the cart for a specified customer.
OpenAPI snippet URL
PUT /V1/carts/mine
Summary: quote Cart Repository V1Save Put
Save quote
OpenAPI snippet URL
POST /V1/carts/mine
Summary: /V1/carts/mine
Creates an empty cart and quote for a specified customer.
OpenAPI snippet URL
POST /V1/carts/mine/balance/apply
Summary: customer Balance Balance Management V1Apply Post
Apply store credit
OpenAPI snippet URL
GET /V1/carts/mine/checkGiftCard/{giftCardCode}
Summary: gift Card Account Gift Card Account Management V1Check Gift Card Get
gift Card Account Gift Card Account Management V1Check Gift Card Get
OpenAPI snippet URL
PARAMETERS /V1/carts/mine/checkGiftCard/{giftCardCode}
OpenAPI snippet URL
PUT /V1/carts/mine/collect-totals
Summary: quote Cart Total Management V1Collect Totals Put
Set shipping/billing methods and additional data for cart and collect totals.
OpenAPI snippet URL
POST /V1/carts/mine/estimate-shipping-methods
Summary: /V1/carts/mine/estimate-shipping-methods
Estimate shipping by address and return list of available shipping methods
OpenAPI snippet URL
POST /V1/carts/mine/estimate-shipping-methods-by-address-id
Summary: /V1/carts/mine/estimate-shipping-methods-by-address-id
Estimate shipping
OpenAPI snippet URL
PUT /V1/carts/mine/order
Summary: /V1/carts/mine/order
Places an order for a specified cart.
OpenAPI snippet URL
GET /V1/carts/mine/payment-methods
Summary: /V1/carts/mine/payment-methods
Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.
OpenAPI snippet URL
POST /V1/carts/mine/set-payment-information
Summary: checkout Payment Information Management V1Save Payment Information Post
Set payment information for a specified cart.
OpenAPI snippet URL
POST /V1/carts/mine/shipping-information
Summary: /V1/carts/mine/shipping-information
/V1/carts/mine/shipping-information
OpenAPI snippet URL
GET /V1/carts/mine/shipping-methods
Summary: /V1/carts/mine/shipping-methods
Lists applicable shipping methods for a specified quote.
OpenAPI snippet URL
GET /V1/carts/mine/totals
Summary: /V1/carts/mine/totals
Returns quote totals data for a specified cart.
OpenAPI snippet URL
POST /V1/carts/mine/totals-information
Summary: /V1/carts/mine/totals-information
Calculate quote totals based on address and shipping method.
OpenAPI snippet URL
GET /V1/carts/{cartId}/billing-address
Summary: /V1/carts/:cartId/billing-address
Returns the billing address for a specified quote.
OpenAPI snippet URL
POST /V1/carts/{cartId}/billing-address
Summary: /V1/carts/:cartId/billing-address
Assigns a specified billing address to a specified cart.
OpenAPI snippet URL
PARAMETERS /V1/carts/{cartId}/billing-address
OpenAPI snippet URL
GET /V1/carts/{cartId}/coupons
Summary: /V1/carts/:cartId/coupons
Returns information for a coupon in a specified cart.
OpenAPI snippet URL
DELETE /V1/carts/{cartId}/coupons
Summary: /V1/carts/:cartId/coupons
Deletes a coupon from a specified cart.
OpenAPI snippet URL
PARAMETERS /V1/carts/{cartId}/coupons
OpenAPI snippet URL
PUT /V1/carts/{cartId}/coupons/{couponCode}
Summary: /V1/carts/:cartId/coupons/:couponCode
Adds a coupon by code to a specified cart.
OpenAPI snippet URL
PARAMETERS /V1/carts/{cartId}/coupons/{couponCode}
OpenAPI snippet URL
GET /V1/carts/{cartId}/gift-message/{itemId}
Summary: /V1/carts/:cartId/gift-message/:itemId
Return the gift message for a specified item in a specified shopping cart.
OpenAPI snippet URL
POST /V1/carts/{cartId}/gift-message/{itemId}
Summary: /V1/carts/:cartId/gift-message/:itemId
Set the gift message for a specified item in a specified shopping cart.
OpenAPI snippet URL
PARAMETERS /V1/carts/{cartId}/gift-message/{itemId}
OpenAPI snippet URL
GET /V1/carts/{cartId}/gift-message
Summary: /V1/carts/:cartId/gift-message
Return the gift message for a specified order.
OpenAPI snippet URL
POST /V1/carts/{cartId}/gift-message
Summary: /V1/carts/:cartId/gift-message
Set the gift message for an entire order.
OpenAPI snippet URL
PARAMETERS /V1/carts/{cartId}/gift-message
OpenAPI snippet URL
PUT /V1/carts/{cartId}/giftCards
Summary: gift Card Account Gift Card Account Management V1Save By Quote Id Put
gift Card Account Gift Card Account Management V1Save By Quote Id Put
OpenAPI snippet URL
PARAMETERS /V1/carts/{cartId}/giftCards
OpenAPI snippet URL
DELETE /V1/carts/{cartId}/giftCards/{giftCardCode}
Summary: /V1/carts/:cartId/giftCards/:giftCardCode
Remove GiftCard Account entity
OpenAPI snippet URL
PARAMETERS /V1/carts/{cartId}/giftCards/{giftCardCode}
OpenAPI snippet URL
PUT /V1/carts/{cartId}/items/{itemId}
Summary: /V1/carts/:cartId/items/:itemId
Add/update the specified cart item.
OpenAPI snippet URL
DELETE /V1/carts/{cartId}/items/{itemId}
Summary: /V1/carts/:cartId/items/:itemId
Removes the specified item from the specified cart.
OpenAPI snippet URL
PARAMETERS /V1/carts/{cartId}/items/{itemId}
OpenAPI snippet URL
GET /V1/carts/{cartId}/items
Summary: /V1/carts/:cartId/items
Lists items that are assigned to a specified cart.
OpenAPI snippet URL
PARAMETERS /V1/carts/{cartId}/items
OpenAPI snippet URL
GET /V1/carts/{cartId}/selected-payment-method
Summary: /V1/carts/:cartId/selected-payment-method
Returns the payment method for a specified shopping cart.
OpenAPI snippet URL
PUT /V1/carts/{cartId}/selected-payment-method
Summary: /V1/carts/:cartId/selected-payment-method
Adds a specified payment method to a specified shopping cart.
OpenAPI snippet URL
PARAMETERS /V1/carts/{cartId}/selected-payment-method
OpenAPI snippet URL
GET /V1/carts/{cartId}
Summary: quote Cart Repository V1Get Get
Enables an administrative user to return information for a specified cart.
OpenAPI snippet URL
PUT /V1/carts/{cartId}
Summary: quote Cart Management V1Assign Customer Put
Assigns a specified customer to a specified shopping cart.
OpenAPI snippet URL
PARAMETERS /V1/carts/{cartId}
OpenAPI snippet URL
POST /V1/carts/{cartId}/estimate-shipping-methods
Summary: /V1/carts/:cartId/estimate-shipping-methods
Estimate shipping by address and return list of available shipping methods
OpenAPI snippet URL
PARAMETERS /V1/carts/{cartId}/estimate-shipping-methods
OpenAPI snippet URL
POST /V1/carts/{cartId}/estimate-shipping-methods-by-address-id
Summary: /V1/carts/:cartId/estimate-shipping-methods-by-address-id
Estimate shipping
OpenAPI snippet URL
PARAMETERS /V1/carts/{cartId}/estimate-shipping-methods-by-address-id
OpenAPI snippet URL
PUT /V1/carts/{cartId}/order
Summary: /V1/carts/:cartId/order
Places an order for a specified cart.
OpenAPI snippet URL
PARAMETERS /V1/carts/{cartId}/order
OpenAPI snippet URL
GET /V1/carts/{cartId}/payment-methods
Summary: /V1/carts/:cartId/payment-methods
Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.
OpenAPI snippet URL
PARAMETERS /V1/carts/{cartId}/payment-methods
OpenAPI snippet URL
POST /V1/carts/{cartId}/shipping-information
Summary: /V1/carts/:cartId/shipping-information
/V1/carts/:cartId/shipping-information
OpenAPI snippet URL
PARAMETERS /V1/carts/{cartId}/shipping-information
OpenAPI snippet URL
GET /V1/carts/{cartId}/shipping-methods
Summary: /V1/carts/:cartId/shipping-methods
Lists applicable shipping methods for a specified quote.
OpenAPI snippet URL
PARAMETERS /V1/carts/{cartId}/shipping-methods
OpenAPI snippet URL
GET /V1/carts/{cartId}/totals
Summary: /V1/carts/:cartId/totals
Returns quote totals data for a specified cart.
OpenAPI snippet URL
PARAMETERS /V1/carts/{cartId}/totals
OpenAPI snippet URL
POST /V1/carts/{cartId}/totals-information
Summary: /V1/carts/:cartId/totals-information
Calculate quote totals based on address and shipping method.
OpenAPI snippet URL
PARAMETERS /V1/carts/{cartId}/totals-information
OpenAPI snippet URL
GET /V1/carts/{quoteId}/giftCards
Summary: gift Card Account Gift Card Account Management V1Get List By Quote Id Get
Return GiftCard Account cards
OpenAPI snippet URL
PARAMETERS /V1/carts/{quoteId}/giftCards
OpenAPI snippet URL
POST /V1/carts/{quoteId}/items
Summary: /V1/carts/:quoteId/items
Add/update the specified cart item.
OpenAPI snippet URL
PARAMETERS /V1/carts/{quoteId}/items
OpenAPI snippet URL
POST /V1/carts/
Summary: quote Cart Management V1Create Empty Cart Post
Creates an empty cart and quote for a guest.
OpenAPI snippet URL
GET /V1/carts/licence
Summary: checkout Agreements Checkout Agreements Repository V1Get List Get
Lists active checkout agreements.
OpenAPI snippet URL
GET /V1/carts/search
Summary: quote Cart Repository V1Get List Get
Enables administrative users to list carts that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#CartRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.
OpenAPI snippet URL
GET /V1/categories/attributes/{attributeCode}
Summary: catalog Category Attribute Repository V1Get Get
Retrieve specific attribute
OpenAPI snippet URL
PARAMETERS /V1/categories/attributes/{attributeCode}
OpenAPI snippet URL
GET /V1/categories/attributes/{attributeCode}/options
Summary: catalog Category Attribute Option Management V1Get Items Get
Retrieve list of attribute options
OpenAPI snippet URL
PARAMETERS /V1/categories/attributes/{attributeCode}/options
OpenAPI snippet URL
GET /V1/categories/attributes
Summary: catalog Category Attribute Repository V1Get List Get
Retrieve all attributes for entity type
OpenAPI snippet URL
GET /V1/categories/{categoryId}/products
Summary: catalog Category Link Management V1Get Assigned Products Get
Get products assigned to category
OpenAPI snippet URL
PUT /V1/categories/{categoryId}/products
Summary: catalog Category Link Repository V1Save Put
Assign a product to the required category
OpenAPI snippet URL
POST /V1/categories/{categoryId}/products
Summary: catalog Category Link Repository V1Save Post
Assign a product to the required category
OpenAPI snippet URL
PARAMETERS /V1/categories/{categoryId}/products
OpenAPI snippet URL
DELETE /V1/categories/{categoryId}/products/{sku}
Summary: catalog Category Link Repository V1Delete By Ids Delete
Remove the product assignment from the category by category id and sku
OpenAPI snippet URL
PARAMETERS /V1/categories/{categoryId}/products/{sku}
OpenAPI snippet URL
GET /V1/categories/{categoryId}
Summary: catalog Category Repository V1Get Get
Get info about category by category id
OpenAPI snippet URL
DELETE /V1/categories/{categoryId}
Summary: catalog Category Repository V1Delete By Identifier Delete
Delete category by identifier
OpenAPI snippet URL
PARAMETERS /V1/categories/{categoryId}
OpenAPI snippet URL
PUT /V1/categories/{categoryId}/move
Summary: catalog Category Management V1Move Put
Move category
OpenAPI snippet URL
PARAMETERS /V1/categories/{categoryId}/move
OpenAPI snippet URL
GET /V1/categories
Summary: catalog Category Management V1Get Tree Get
Retrieve list of categories
OpenAPI snippet URL
POST /V1/categories
Summary: catalog Category Repository V1Save Post
Create category service
OpenAPI snippet URL
PUT /V1/categories/{id}
Summary: catalog Category Repository V1Save Put
Create category service
OpenAPI snippet URL
PARAMETERS /V1/categories/{id}
OpenAPI snippet URL
GET /V1/cmsBlock/{blockId}
Summary: cms Block Repository V1Get By Id Get
Retrieve block.
OpenAPI snippet URL
DELETE /V1/cmsBlock/{blockId}
Summary: cms Block Repository V1Delete By Id Delete
Delete block by ID.
OpenAPI snippet URL
PARAMETERS /V1/cmsBlock/{blockId}
OpenAPI snippet URL
POST /V1/cmsBlock
Summary: cms Block Repository V1Save Post
Save block.
OpenAPI snippet URL
GET /V1/cmsBlock/search
Summary: cms Block Repository V1Get List Get
Retrieve blocks matching the specified criteria.
OpenAPI snippet URL
PUT /V1/cmsBlock/{id}
Summary: cms Block Repository V1Save Put
Save block.
OpenAPI snippet URL
PARAMETERS /V1/cmsBlock/{id}
OpenAPI snippet URL
GET /V1/cmsPage/{pageId}
Summary: cms Page Repository V1Get By Id Get
Retrieve page.
OpenAPI snippet URL
DELETE /V1/cmsPage/{pageId}
Summary: cms Page Repository V1Delete By Id Delete
Delete page by ID.
OpenAPI snippet URL
PARAMETERS /V1/cmsPage/{pageId}
OpenAPI snippet URL
POST /V1/cmsPage
Summary: cms Page Repository V1Save Post
Save page.
OpenAPI snippet URL
GET /V1/cmsPage/search
Summary: cms Page Repository V1Get List Get
Retrieve pages matching the specified criteria.
OpenAPI snippet URL
PUT /V1/cmsPage/{id}
Summary: cms Page Repository V1Save Put
Save page.
OpenAPI snippet URL
PARAMETERS /V1/cmsPage/{id}
OpenAPI snippet URL
GET /V1/configurable-products/{sku}/children
Summary: configurable Product Link Management V1Get Children Get
Get all children for Configurable product
OpenAPI snippet URL
PARAMETERS /V1/configurable-products/{sku}/children
OpenAPI snippet URL
DELETE /V1/configurable-products/{sku}/children/{childSku}
Summary: configurable Product Link Management V1Remove Child Delete
Remove configurable product option
OpenAPI snippet URL
PARAMETERS /V1/configurable-products/{sku}/children/{childSku}
OpenAPI snippet URL
GET /V1/configurable-products/{sku}/options/{id}
Summary: configurable Product Option Repository V1Get Get
Get option for configurable product
OpenAPI snippet URL
PUT /V1/configurable-products/{sku}/options/{id}
Summary: configurable Product Option Repository V1Save Put
Save option
OpenAPI snippet URL
DELETE /V1/configurable-products/{sku}/options/{id}
Summary: configurable Product Option Repository V1Delete By Id Delete
Remove option from configurable product
OpenAPI snippet URL
PARAMETERS /V1/configurable-products/{sku}/options/{id}
OpenAPI snippet URL
POST /V1/configurable-products/{sku}/options
Summary: configurable Product Option Repository V1Save Post
Save option
OpenAPI snippet URL
PARAMETERS /V1/configurable-products/{sku}/options
OpenAPI snippet URL
GET /V1/configurable-products/{sku}/options/all
Summary: configurable Product Option Repository V1Get List Get
Get all options for configurable product
OpenAPI snippet URL
PARAMETERS /V1/configurable-products/{sku}/options/all
OpenAPI snippet URL
POST /V1/configurable-products/{sku}/child
Summary: configurable Product Link Management V1Add Child Post
configurable Product Link Management V1Add Child Post
OpenAPI snippet URL
PARAMETERS /V1/configurable-products/{sku}/child
OpenAPI snippet URL
PUT /V1/configurable-products/variation
Summary: configurable Product Configurable Product Management V1Generate Variation Put
Generate variation based on same product
OpenAPI snippet URL
GET /V1/coupons/{couponId}
Summary: sales Rule Coupon Repository V1Get By Id Get
Get coupon by coupon id.
OpenAPI snippet URL
PUT /V1/coupons/{couponId}
Summary: sales Rule Coupon Repository V1Save Put
Save a coupon.
OpenAPI snippet URL
DELETE /V1/coupons/{couponId}
Summary: sales Rule Coupon Repository V1Delete By Id Delete
Delete coupon by coupon id.
OpenAPI snippet URL
PARAMETERS /V1/coupons/{couponId}
OpenAPI snippet URL
POST /V1/coupons
Summary: sales Rule Coupon Repository V1Save Post
Save a coupon.
OpenAPI snippet URL
POST /V1/coupons/deleteByCodes
Summary: sales Rule Coupon Management V1Delete By Codes Post
Delete coupon by coupon codes.
OpenAPI snippet URL
POST /V1/coupons/deleteByIds
Summary: sales Rule Coupon Management V1Delete By Ids Post
Delete coupon by coupon ids.
OpenAPI snippet URL
POST /V1/coupons/generate
Summary: sales Rule Coupon Management V1Generate Post
Generate coupon for a rule
OpenAPI snippet URL
GET /V1/coupons/search
Summary: sales Rule Coupon Repository V1Get List Get
Retrieve a coupon using the specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#CouponRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.
OpenAPI snippet URL
GET /V1/creditmemo/{id}/comments
Summary: sales Creditmemo Management V1Get Comments List Get
Lists comments for a specified credit memo.
OpenAPI snippet URL
POST /V1/creditmemo/{id}/comments
Summary: sales Creditmemo Comment Repository V1Save Post
Performs persist operations for a specified entity.
OpenAPI snippet URL
PARAMETERS /V1/creditmemo/{id}/comments
OpenAPI snippet URL
GET /V1/creditmemo/{id}
Summary: sales Creditmemo Repository V1Get Get
Loads a specified credit memo.
OpenAPI snippet URL
PUT /V1/creditmemo/{id}
Summary: sales Creditmemo Management V1Cancel Put
Cancels a specified credit memo.
OpenAPI snippet URL
PARAMETERS /V1/creditmemo/{id}
OpenAPI snippet URL
POST /V1/creditmemo/{id}/emails
Summary: sales Creditmemo Management V1Notify Post
Emails a user a specified credit memo.
OpenAPI snippet URL
PARAMETERS /V1/creditmemo/{id}/emails
OpenAPI snippet URL
POST /V1/creditmemo
Summary: sales Creditmemo Repository V1Save Post
Performs persist operations for a specified credit memo.
OpenAPI snippet URL
POST /V1/creditmemo/refund
Summary: sales Creditmemo Management V1Refund Post
Prepare creditmemo to refund and save it.
OpenAPI snippet URL
GET /V1/customerGroups/default
Summary: /V1/customerGroups/default
Get default customer group.
OpenAPI snippet URL
GET /V1/customerGroups/default/{storeId}
Summary: /V1/customerGroups/default/:storeId
Get default customer group.
OpenAPI snippet URL
PARAMETERS /V1/customerGroups/default/{storeId}
OpenAPI snippet URL
GET /V1/customerGroups/{id}
Summary: customer Group Repository V1Get By Id Get
Get customer group by group ID.
OpenAPI snippet URL
PUT /V1/customerGroups/{id}
Summary: customer Group Repository V1Save Put
Save customer group.
OpenAPI snippet URL
DELETE /V1/customerGroups/{id}
Summary: customer Group Repository V1Delete By Id Delete
Delete customer group by ID.
OpenAPI snippet URL
PARAMETERS /V1/customerGroups/{id}
OpenAPI snippet URL
GET /V1/customerGroups/{id}/permissions
Summary: customer Group Management V1Is Readonly Get
Check if customer group can be deleted.
OpenAPI snippet URL
PARAMETERS /V1/customerGroups/{id}/permissions
OpenAPI snippet URL
POST /V1/customerGroups
Summary: customer Group Repository V1Save Post
Save customer group.
OpenAPI snippet URL
GET /V1/customerGroups/search
Summary: customer Group Repository V1Get List Get
Retrieve customer groups. The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can be filtered by tax class. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#GroupRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.
OpenAPI snippet URL
GET /V1/customers/me
Summary: /V1/customers/me
Get customer by customer ID.
OpenAPI snippet URL
PUT /V1/customers/me
Summary: /V1/customers/me
Create or update a customer.
OpenAPI snippet URL
PUT /V1/customers/me/activate
Summary: customer Account Management V1Activate By Id Put
Activate a customer account using a key that was sent in a confirmation email.
OpenAPI snippet URL
GET /V1/customers/me/billingAddress
Summary: /V1/customers/me/billingAddress
Retrieve default billing address for the given customerId.
OpenAPI snippet URL
PUT /V1/customers/me/password
Summary: customer Account Management V1Change Password By Id Put
Change customer password.
OpenAPI snippet URL
GET /V1/customers/me/shippingAddress
Summary: /V1/customers/me/shippingAddress
Retrieve default shipping address for the given customerId.
OpenAPI snippet URL
GET /V1/customers/{customerId}
Summary: /V1/customers/:customerId
Get customer by customer ID.
OpenAPI snippet URL
DELETE /V1/customers/{customerId}
Summary: customer Customer Repository V1Delete By Id Delete
Delete customer by ID.
OpenAPI snippet URL
PARAMETERS /V1/customers/{customerId}
OpenAPI snippet URL
GET /V1/customers/{customerId}/billingAddress
Summary: /V1/customers/:customerId/billingAddress
Retrieve default billing address for the given customerId.
OpenAPI snippet URL
PARAMETERS /V1/customers/{customerId}/billingAddress
OpenAPI snippet URL
POST /V1/customers/{customerId}/carts
Summary: /V1/customers/:customerId/carts
Creates an empty cart and quote for a specified customer.
OpenAPI snippet URL
PARAMETERS /V1/customers/{customerId}/carts
OpenAPI snippet URL
GET /V1/customers/{customerId}/confirm
Summary: customer Account Management V1Get Confirmation Status Get
Gets the account confirmation status.
OpenAPI snippet URL
PARAMETERS /V1/customers/{customerId}/confirm
OpenAPI snippet URL
GET /V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
Summary: customer Account Management V1Validate Reset Password Link Token Get
Check if password reset token is valid.
OpenAPI snippet URL
PARAMETERS /V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
OpenAPI snippet URL
GET /V1/customers/{customerId}/permissions/readonly
Summary: customer Account Management V1Is Readonly Get
Check if customer can be deleted.
OpenAPI snippet URL
PARAMETERS /V1/customers/{customerId}/permissions/readonly
OpenAPI snippet URL
GET /V1/customers/{customerId}/shippingAddress
Summary: /V1/customers/:customerId/shippingAddress
Retrieve default shipping address for the given customerId.
OpenAPI snippet URL
PARAMETERS /V1/customers/{customerId}/shippingAddress
OpenAPI snippet URL
POST /V1/customers
Summary: customer Account Management V1Create Account Post
Create customer account. Perform necessary business operations like sending email.
OpenAPI snippet URL
GET /V1/customers/addresses/{addressId}
Summary: customer Address Repository V1Get By Id Get
Retrieve customer address.
OpenAPI snippet URL
PARAMETERS /V1/customers/addresses/{addressId}
OpenAPI snippet URL
POST /V1/customers/confirm
Summary: customer Account Management V1Resend Confirmation Post
Resend confirmation email.
OpenAPI snippet URL
POST /V1/customers/isEmailAvailable
Summary: customer Account Management V1Is Email Available Post
Check if given email is associated with a customer account in given website.
OpenAPI snippet URL
PUT /V1/customers/password
Summary: customer Account Management V1Initiate Password Reset Put
Send an email to the customer with a password reset link.
OpenAPI snippet URL
GET /V1/customers/search
Summary: customer Customer Repository V1Get List Get
Retrieve customers which match a specified criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#CustomerRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.
OpenAPI snippet URL
PUT /V1/customers/validate
Summary: customer Account Management V1Validate Put
Validate customer data.
OpenAPI snippet URL
PUT /V1/customers/{email}/activate
Summary: customer Account Management V1Activate Put
Activate a customer account using a key that was sent in a confirmation email.
OpenAPI snippet URL
PARAMETERS /V1/customers/{email}/activate
OpenAPI snippet URL
PUT /V1/customers/{id}
Summary: /V1/customers/:id
Create or update a customer.
OpenAPI snippet URL
PARAMETERS /V1/customers/{id}
OpenAPI snippet URL
GET /V1/directory/countries
Summary: directory Country Information Acquirer V1Get Countries Info Get
Get all countries and regions information for the store.
OpenAPI snippet URL
GET /V1/directory/countries/{countryId}
Summary: directory Country Information Acquirer V1Get Country Info Get
Get country and region information for the store.
OpenAPI snippet URL
PARAMETERS /V1/directory/countries/{countryId}
OpenAPI snippet URL
GET /V1/directory/currency
Summary: directory Currency Information Acquirer V1Get Currency Info Get
Get currency information for the store.
OpenAPI snippet URL
GET /V1/eav/attribute-sets/{attributeSetId}
Summary: eav Attribute Set Repository V1Get Get
Retrieve attribute set information based on given ID
OpenAPI snippet URL
PUT /V1/eav/attribute-sets/{attributeSetId}
Summary: eav Attribute Set Repository V1Save Put
Save attribute set data
OpenAPI snippet URL
DELETE /V1/eav/attribute-sets/{attributeSetId}
Summary: eav Attribute Set Repository V1Delete By Id Delete
Remove attribute set by given ID
OpenAPI snippet URL
PARAMETERS /V1/eav/attribute-sets/{attributeSetId}
OpenAPI snippet URL
POST /V1/eav/attribute-sets
Summary: eav Attribute Set Management V1Create Post
Create attribute set from data
OpenAPI snippet URL
GET /V1/eav/attribute-sets/list
Summary: eav Attribute Set Repository V1Get List Get
Retrieve list of Attribute Sets This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#AttributeSetRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.
OpenAPI snippet URL
GET /V1/gift-wrappings/{id}
Summary: gift Wrapping Wrapping Repository V1Get Get
Return data object for specified wrapping ID and store.
OpenAPI snippet URL
DELETE /V1/gift-wrappings/{id}
Summary: gift Wrapping Wrapping Repository V1Delete By Id Delete
Delete gift wrapping
OpenAPI snippet URL
PARAMETERS /V1/gift-wrappings/{id}
OpenAPI snippet URL
GET /V1/gift-wrappings
Summary: gift Wrapping Wrapping Repository V1Get List Get
Return list of gift wrapping data objects based on search criteria
OpenAPI snippet URL
POST /V1/gift-wrappings
Summary: gift Wrapping Wrapping Repository V1Save Post
Create/Update new gift wrapping with data object values
OpenAPI snippet URL
PUT /V1/gift-wrappings/{wrappingId}
Summary: gift Wrapping Wrapping Repository V1Save Put
Create/Update new gift wrapping with data object values
OpenAPI snippet URL
PARAMETERS /V1/gift-wrappings/{wrappingId}
OpenAPI snippet URL
GET /V1/guest-carts/{cartId}/billing-address
Summary: quote Guest Billing Address Management V1Get Get
Return the billing address for a specified quote.
OpenAPI snippet URL
POST /V1/guest-carts/{cartId}/billing-address
Summary: quote Guest Billing Address Management V1Assign Post
Assign a specified billing address to a specified cart.
OpenAPI snippet URL
PARAMETERS /V1/guest-carts/{cartId}/billing-address
OpenAPI snippet URL
GET /V1/guest-carts/{cartId}/coupons
Summary: quote Guest Coupon Management V1Get Get
Return information for a coupon in a specified cart.
OpenAPI snippet URL
DELETE /V1/guest-carts/{cartId}/coupons
Summary: quote Guest Coupon Management V1Remove Delete
Delete a coupon from a specified cart.
OpenAPI snippet URL
PARAMETERS /V1/guest-carts/{cartId}/coupons
OpenAPI snippet URL
PUT /V1/guest-carts/{cartId}/coupons/{couponCode}
Summary: quote Guest Coupon Management V1Set Put
Add a coupon by code to a specified cart.
OpenAPI snippet URL
PARAMETERS /V1/guest-carts/{cartId}/coupons/{couponCode}
OpenAPI snippet URL
GET /V1/guest-carts/{cartId}/gift-message/{itemId}
Summary: gift Message Guest Item Repository V1Get Get
Return the gift message for a specified item in a specified shopping cart.
OpenAPI snippet URL
POST /V1/guest-carts/{cartId}/gift-message/{itemId}
Summary: gift Message Guest Item Repository V1Save Post
Set the gift message for a specified item in a specified shopping cart.
OpenAPI snippet URL
PARAMETERS /V1/guest-carts/{cartId}/gift-message/{itemId}
OpenAPI snippet URL
GET /V1/guest-carts/{cartId}/gift-message
Summary: gift Message Guest Cart Repository V1Get Get
Return the gift message for a specified order.
OpenAPI snippet URL
POST /V1/guest-carts/{cartId}/gift-message
Summary: gift Message Guest Cart Repository V1Save Post
Set the gift message for an entire order.
OpenAPI snippet URL
PARAMETERS /V1/guest-carts/{cartId}/gift-message
OpenAPI snippet URL
PUT /V1/guest-carts/{cartId}/items/{itemId}
Summary: quote Guest Cart Item Repository V1Save Put
Add the specified item to the specified cart.
OpenAPI snippet URL
DELETE /V1/guest-carts/{cartId}/items/{itemId}
Summary: quote Guest Cart Item Repository V1Delete By Id Delete
Remove the specified item from the specified cart.
OpenAPI snippet URL
PARAMETERS /V1/guest-carts/{cartId}/items/{itemId}
OpenAPI snippet URL
GET /V1/guest-carts/{cartId}/items
Summary: quote Guest Cart Item Repository V1Get List Get
List items that are assigned to a specified cart.
OpenAPI snippet URL
POST /V1/guest-carts/{cartId}/items
Summary: quote Guest Cart Item Repository V1Save Post
Add the specified item to the specified cart.
OpenAPI snippet URL
PARAMETERS /V1/guest-carts/{cartId}/items
OpenAPI snippet URL
GET /V1/guest-carts/{cartId}/payment-information
Summary: checkout Guest Payment Information Management V1Get Payment Information Get
Get payment information
OpenAPI snippet URL
POST /V1/guest-carts/{cartId}/payment-information
Summary: checkout Guest Payment Information Management V1Save Payment Information And Place Order Post
Set payment information and place order for a specified cart.
OpenAPI snippet URL
PARAMETERS /V1/guest-carts/{cartId}/payment-information
OpenAPI snippet URL
GET /V1/guest-carts/{cartId}/selected-payment-method
Summary: quote Guest Payment Method Management V1Get Get
Return the payment method for a specified shopping cart.
OpenAPI snippet URL
PUT /V1/guest-carts/{cartId}/selected-payment-method
Summary: quote Guest Payment Method Management V1Set Put
Add a specified payment method to a specified shopping cart.
OpenAPI snippet URL
PARAMETERS /V1/guest-carts/{cartId}/selected-payment-method
OpenAPI snippet URL
GET /V1/guest-carts/{cartId}
Summary: quote Guest Cart Repository V1Get Get
Enable a guest user to return information for a specified cart.
OpenAPI snippet URL
PUT /V1/guest-carts/{cartId}
Summary: quote Guest Cart Management V1Assign Customer Put
Assign a specified customer to a specified shopping cart.
OpenAPI snippet URL
PARAMETERS /V1/guest-carts/{cartId}
OpenAPI snippet URL
PUT /V1/guest-carts/{cartId}/collect-totals
Summary: quote Guest Cart Total Management V1Collect Totals Put
Set shipping/billing methods and additional data for cart and collect totals for guest.
OpenAPI snippet URL
PARAMETERS /V1/guest-carts/{cartId}/collect-totals
OpenAPI snippet URL
POST /V1/guest-carts/{cartId}/estimate-shipping-methods
Summary: quote Guest Shipment Estimation V1Estimate By Extended Address Post
Estimate shipping by address and return list of available shipping methods
OpenAPI snippet URL
PARAMETERS /V1/guest-carts/{cartId}/estimate-shipping-methods
OpenAPI snippet URL
PUT /V1/guest-carts/{cartId}/order
Summary: quote Guest Cart Management V1Place Order Put
Place an order for a specified cart.
OpenAPI snippet URL
PARAMETERS /V1/guest-carts/{cartId}/order
OpenAPI snippet URL
GET /V1/guest-carts/{cartId}/payment-methods
Summary: quote Guest Payment Method Management V1Get List Get
List available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#GuestPaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.
OpenAPI snippet URL
PARAMETERS /V1/guest-carts/{cartId}/payment-methods
OpenAPI snippet URL
POST /V1/guest-carts/{cartId}/set-payment-information
Summary: checkout Guest Payment Information Management V1Save Payment Information Post
Set payment information for a specified cart.
OpenAPI snippet URL
PARAMETERS /V1/guest-carts/{cartId}/set-payment-information
OpenAPI snippet URL
POST /V1/guest-carts/{cartId}/shipping-information
Summary: checkout Guest Shipping Information Management V1Save Address Information Post
checkout Guest Shipping Information Management V1Save Address Information Post
OpenAPI snippet URL
PARAMETERS /V1/guest-carts/{cartId}/shipping-information
OpenAPI snippet URL
GET /V1/guest-carts/{cartId}/shipping-methods
Summary: quote Guest Shipping Method Management V1Get List Get
List applicable shipping methods for a specified quote.
OpenAPI snippet URL
PARAMETERS /V1/guest-carts/{cartId}/shipping-methods
OpenAPI snippet URL
GET /V1/guest-carts/{cartId}/totals
Summary: quote Guest Cart Total Repository V1Get Get
Return quote totals data for a specified cart.
OpenAPI snippet URL
PARAMETERS /V1/guest-carts/{cartId}/totals
OpenAPI snippet URL
POST /V1/guest-carts/{cartId}/totals-information
Summary: checkout Guest Totals Information Management V1Calculate Post
Calculate quote totals based on address and shipping method.
OpenAPI snippet URL
PARAMETERS /V1/guest-carts/{cartId}/totals-information
OpenAPI snippet URL
POST /V1/guest-carts
Summary: quote Guest Cart Management V1Create Empty Cart Post
Enable an customer or guest user to create an empty cart and quote for an anonymous customer.
OpenAPI snippet URL
POST /V1/integration/admin/token
Summary: integration Admin Token Service V1Create Admin Access Token Post
Create access token for admin given the admin credentials.
OpenAPI snippet URL
POST /V1/integration/customer/token
Summary: integration Customer Token Service V1Create Customer Access Token Post
Create access token for admin given the customer credentials.
OpenAPI snippet URL
GET /V1/invoices/{id}
Summary: sales Invoice Repository V1Get Get
Loads a specified invoice.
OpenAPI snippet URL
PARAMETERS /V1/invoices/{id}
OpenAPI snippet URL
POST /V1/invoices/{id}/capture
Summary: sales Invoice Management V1Set Capture Post
Sets invoice capture.
OpenAPI snippet URL
PARAMETERS /V1/invoices/{id}/capture
OpenAPI snippet URL
GET /V1/invoices/{id}/comments
Summary: sales Invoice Management V1Get Comments List Get
Lists comments for a specified invoice.
OpenAPI snippet URL
PARAMETERS /V1/invoices/{id}/comments
OpenAPI snippet URL
POST /V1/invoices/{id}/emails
Summary: sales Invoice Management V1Notify Post
Emails a user a specified invoice.
OpenAPI snippet URL
PARAMETERS /V1/invoices/{id}/emails
OpenAPI snippet URL
POST /V1/invoices/{id}/void
Summary: sales Invoice Management V1Set Void Post
Voids a specified invoice.
OpenAPI snippet URL
PARAMETERS /V1/invoices/{id}/void
OpenAPI snippet URL
GET /V1/invoices
Summary: sales Invoice Repository V1Get List Get
Lists invoices that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#InvoiceRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.
OpenAPI snippet URL
POST /V1/invoices/
Summary: sales Invoice Repository V1Save Post
Performs persist operations for a specified invoice.
OpenAPI snippet URL
POST /V1/invoices/comments
Summary: sales Invoice Comment Repository V1Save Post
Performs persist operations for a specified invoice comment.
OpenAPI snippet URL
POST /V1/order/{orderId}/invoice
Summary: sales Invoice Order V1Execute Post
sales Invoice Order V1Execute Post
OpenAPI snippet URL
PARAMETERS /V1/order/{orderId}/invoice
OpenAPI snippet URL
POST /V1/order/{orderId}/refund
Summary: sales Refund Order V1Execute Post
Create offline refund for order
OpenAPI snippet URL
PARAMETERS /V1/order/{orderId}/refund
OpenAPI snippet URL
POST /V1/order/{orderId}/ship
Summary: sales Ship Order V1Execute Post
Creates new Shipment for given Order.
OpenAPI snippet URL
PARAMETERS /V1/order/{orderId}/ship
OpenAPI snippet URL
GET /V1/orders/items
Summary: sales Order Item Repository V1Get List Get
Lists order items that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#OrderItemRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.
OpenAPI snippet URL
GET /V1/orders/items/{id}
Summary: sales Order Item Repository V1Get Get
Loads a specified order item.
OpenAPI snippet URL
PARAMETERS /V1/orders/items/{id}
OpenAPI snippet URL
GET /V1/orders/{id}/comments
Summary: sales Order Management V1Get Comments List Get
Lists comments for a specified order.
OpenAPI snippet URL
POST /V1/orders/{id}/comments
Summary: sales Order Management V1Add Comment Post
Adds a comment to a specified order.
OpenAPI snippet URL
PARAMETERS /V1/orders/{id}/comments
OpenAPI snippet URL
GET /V1/orders/{id}
Summary: sales Order Repository V1Get Get
Loads a specified order.
OpenAPI snippet URL
PARAMETERS /V1/orders/{id}
OpenAPI snippet URL
POST /V1/orders/{id}/cancel
Summary: sales Order Management V1Cancel Post
Cancels a specified order.
OpenAPI snippet URL
PARAMETERS /V1/orders/{id}/cancel
OpenAPI snippet URL
POST /V1/orders/{id}/emails
Summary: sales Order Management V1Notify Post
Emails a user a specified order.
OpenAPI snippet URL
PARAMETERS /V1/orders/{id}/emails
OpenAPI snippet URL
POST /V1/orders/{id}/hold
Summary: sales Order Management V1Hold Post
Holds a specified order.
OpenAPI snippet URL
PARAMETERS /V1/orders/{id}/hold
OpenAPI snippet URL
GET /V1/orders/{id}/statuses
Summary: sales Order Management V1Get Status Get
Gets the status for a specified order.
OpenAPI snippet URL
PARAMETERS /V1/orders/{id}/statuses
OpenAPI snippet URL
POST /V1/orders/{id}/unhold
Summary: sales Order Management V1Un Hold Post
Releases a specified order from hold status.
OpenAPI snippet URL
PARAMETERS /V1/orders/{id}/unhold
OpenAPI snippet URL
GET /V1/orders
Summary: sales Order Repository V1Get List Get
Lists orders that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#OrderRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.
OpenAPI snippet URL
POST /V1/orders/
Summary: sales Order Repository V1Save Post
Performs persist operations for a specified order.
OpenAPI snippet URL
PUT /V1/orders/create
Summary: sales Order Repository V1Save Put
Performs persist operations for a specified order.
OpenAPI snippet URL
PUT /V1/orders/{parent_id}
Summary: sales Order Address Repository V1Save Put
Performs persist operations for a specified order address.
OpenAPI snippet URL
PARAMETERS /V1/orders/{parent_id}
OpenAPI snippet URL
POST /V1/products/attribute-sets/groups
Summary: catalog Product Attribute Group Repository V1Save Post
Save attribute group
OpenAPI snippet URL
GET /V1/products/attribute-sets/groups/list
Summary: catalog Product Attribute Group Repository V1Get List Get
Retrieve list of attribute groups
OpenAPI snippet URL
DELETE /V1/products/attribute-sets/groups/{groupId}
Summary: catalog Product Attribute Group Repository V1Delete By Id Delete
Remove attribute group by id
OpenAPI snippet URL
PARAMETERS /V1/products/attribute-sets/groups/{groupId}
OpenAPI snippet URL
GET /V1/products/attribute-sets/{attributeSetId}/attributes
Summary: catalog Product Attribute Management V1Get Attributes Get
Retrieve related attributes based on given attribute set ID
OpenAPI snippet URL
PARAMETERS /V1/products/attribute-sets/{attributeSetId}/attributes
OpenAPI snippet URL
DELETE /V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}
Summary: catalog Product Attribute Management V1Unassign Delete
Remove attribute from attribute set
OpenAPI snippet URL
PARAMETERS /V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}
OpenAPI snippet URL
GET /V1/products/attribute-sets/{attributeSetId}
Summary: catalog Attribute Set Repository V1Get Get
Retrieve attribute set information based on given ID
OpenAPI snippet URL
PUT /V1/products/attribute-sets/{attributeSetId}
Summary: catalog Attribute Set Repository V1Save Put
Save attribute set data
OpenAPI snippet URL
DELETE /V1/products/attribute-sets/{attributeSetId}
Summary: catalog Attribute Set Repository V1Delete By Id Delete
Remove attribute set by given ID
OpenAPI snippet URL
PARAMETERS /V1/products/attribute-sets/{attributeSetId}
OpenAPI snippet URL
PUT /V1/products/attribute-sets/{attributeSetId}/groups
Summary: catalog Product Attribute Group Repository V1Save Put
Save attribute group
OpenAPI snippet URL
PARAMETERS /V1/products/attribute-sets/{attributeSetId}/groups
OpenAPI snippet URL
POST /V1/products/attribute-sets
Summary: catalog Attribute Set Management V1Create Post
Create attribute set from data
OpenAPI snippet URL
POST /V1/products/attribute-sets/attributes
Summary: catalog Product Attribute Management V1Assign Post
Assign attribute to attribute set
OpenAPI snippet URL
GET /V1/products/attribute-sets/sets/list
Summary: catalog Attribute Set Repository V1Get List Get
Retrieve list of Attribute Sets
OpenAPI snippet URL
GET /V1/products/attributes/{attributeCode}/options
Summary: catalog Product Attribute Option Management V1Get Items Get
Retrieve list of attribute options
OpenAPI snippet URL
POST /V1/products/attributes/{attributeCode}/options
Summary: catalog Product Attribute Option Management V1Add Post
Add option to attribute
OpenAPI snippet URL
PARAMETERS /V1/products/attributes/{attributeCode}/options
OpenAPI snippet URL
DELETE /V1/products/attributes/{attributeCode}/options/{optionId}
Summary: catalog Product Attribute Option Management V1Delete Delete
Delete option from attribute
OpenAPI snippet URL
PARAMETERS /V1/products/attributes/{attributeCode}/options/{optionId}
OpenAPI snippet URL
GET /V1/products/attributes/{attributeCode}
Summary: catalog Product Attribute Repository V1Get Get
Retrieve specific attribute
OpenAPI snippet URL
PUT /V1/products/attributes/{attributeCode}
Summary: catalog Product Attribute Repository V1Save Put
Save attribute data
OpenAPI snippet URL
DELETE /V1/products/attributes/{attributeCode}
Summary: catalog Product Attribute Repository V1Delete By Id Delete
Delete Attribute by id
OpenAPI snippet URL
PARAMETERS /V1/products/attributes/{attributeCode}
OpenAPI snippet URL
GET /V1/products/attributes
Summary: catalog Product Attribute Repository V1Get List Get
Retrieve all attributes for entity type
OpenAPI snippet URL
POST /V1/products/attributes
Summary: catalog Product Attribute Repository V1Save Post
Save attribute data
OpenAPI snippet URL
GET /V1/products/attributes/types
Summary: catalog Product Attribute Types List V1Get Items Get
Retrieve list of product attribute types
OpenAPI snippet URL
DELETE /V1/products/downloadable-links/samples/{id}
Summary: downloadable Sample Repository V1Delete Delete
Delete downloadable sample
OpenAPI snippet URL
PARAMETERS /V1/products/downloadable-links/samples/{id}
OpenAPI snippet URL
DELETE /V1/products/downloadable-links/{id}
Summary: downloadable Link Repository V1Delete Delete
Delete downloadable link
OpenAPI snippet URL
PARAMETERS /V1/products/downloadable-links/{id}
OpenAPI snippet URL
GET /V1/products/links/types
Summary: catalog Product Link Type List V1Get Items Get
Retrieve information about available product link types
OpenAPI snippet URL
GET /V1/products/links/{type}/attributes
Summary: catalog Product Link Type List V1Get Item Attributes Get
Provide a list of the product link type attributes
OpenAPI snippet URL
PARAMETERS /V1/products/links/{type}/attributes
OpenAPI snippet URL
POST /V1/products/options
Summary: catalog Product Custom Option Repository V1Save Post
Save Custom Option
OpenAPI snippet URL
GET /V1/products/options/types
Summary: catalog Product Custom Option Type List V1Get Items Get
Get custom option types
OpenAPI snippet URL
PUT /V1/products/options/{optionId}
Summary: catalog Product Custom Option Repository V1Save Put
Save Custom Option
OpenAPI snippet URL
PARAMETERS /V1/products/options/{optionId}
OpenAPI snippet URL
GET /V1/products/{sku}/downloadable-links/samples
Summary: downloadable Sample Repository V1Get List Get
List of samples for downloadable product
OpenAPI snippet URL
POST /V1/products/{sku}/downloadable-links/samples
Summary: downloadable Sample Repository V1Save Post
Update downloadable sample of the given product
OpenAPI snippet URL
PARAMETERS /V1/products/{sku}/downloadable-links/samples
OpenAPI snippet URL
PUT /V1/products/{sku}/downloadable-links/samples/{id}
Summary: downloadable Sample Repository V1Save Put
Update downloadable sample of the given product
OpenAPI snippet URL
PARAMETERS /V1/products/{sku}/downloadable-links/samples/{id}
OpenAPI snippet URL
GET /V1/products/{sku}/downloadable-links
Summary: downloadable Link Repository V1Get List Get
List of links with associated samples
OpenAPI snippet URL
POST /V1/products/{sku}/downloadable-links
Summary: downloadable Link Repository V1Save Post
Update downloadable link of the given product (link type and its resources cannot be changed)
OpenAPI snippet URL
PARAMETERS /V1/products/{sku}/downloadable-links
OpenAPI snippet URL
PUT /V1/products/{sku}/downloadable-links/{id}
Summary: downloadable Link Repository V1Save Put
Update downloadable link of the given product (link type and its resources cannot be changed)
OpenAPI snippet URL
PARAMETERS /V1/products/{sku}/downloadable-links/{id}
OpenAPI snippet URL
DELETE /V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}
Summary: catalog Product Tier Price Management V1Remove Delete
Remove tier price from product
OpenAPI snippet URL
PARAMETERS /V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}
OpenAPI snippet URL
POST /V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}
Summary: catalog Product Tier Price Management V1Add Post
Create tier price for product
OpenAPI snippet URL
PARAMETERS /V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}
OpenAPI snippet URL
GET /V1/products/{sku}/group-prices/{customerGroupId}/tiers
Summary: catalog Product Tier Price Management V1Get List Get
Get tier price of product
OpenAPI snippet URL
PARAMETERS /V1/products/{sku}/group-prices/{customerGroupId}/tiers
OpenAPI snippet URL
GET /V1/products/{sku}/links/{type}
Summary: catalog Product Link Management V1Get Linked Items By Type Get
Provide the list of links for a specific product
OpenAPI snippet URL
PARAMETERS /V1/products/{sku}/links/{type}
OpenAPI snippet URL
DELETE /V1/products/{sku}/links/{type}/{linkedProductSku}
Summary: catalog Product Link Repository V1Delete By Id Delete
catalog Product Link Repository V1Delete By Id Delete
OpenAPI snippet URL
PARAMETERS /V1/products/{sku}/links/{type}/{linkedProductSku}
OpenAPI snippet URL
PUT /V1/products/{sku}/links
Summary: catalog Product Link Repository V1Save Put
Save product link
OpenAPI snippet URL
POST /V1/products/{sku}/links
Summary: catalog Product Link Management V1Set Product Links Post
Assign a product link to another product
OpenAPI snippet URL
PARAMETERS /V1/products/{sku}/links
OpenAPI snippet URL
GET /V1/products/{sku}/media/{entryId}
Summary: catalog Product Attribute Media Gallery Management V1Get Get
Return information about gallery entry
OpenAPI snippet URL
PUT /V1/products/{sku}/media/{entryId}
Summary: catalog Product Attribute Media Gallery Management V1Update Put
Update gallery entry
OpenAPI snippet URL
DELETE /V1/products/{sku}/media/{entryId}
Summary: catalog Product Attribute Media Gallery Management V1Remove Delete
Remove gallery entry
OpenAPI snippet URL
PARAMETERS /V1/products/{sku}/media/{entryId}
OpenAPI snippet URL
GET /V1/products/{sku}/media
Summary: catalog Product Attribute Media Gallery Management V1Get List Get
Retrieve the list of gallery entries associated with given product
OpenAPI snippet URL
POST /V1/products/{sku}/media
Summary: catalog Product Attribute Media Gallery Management V1Create Post
Create new gallery entry
OpenAPI snippet URL
PARAMETERS /V1/products/{sku}/media
OpenAPI snippet URL
GET /V1/products/{sku}/options/{optionId}
Summary: catalog Product Custom Option Repository V1Get Get
Get custom option for a specific product
OpenAPI snippet URL
DELETE /V1/products/{sku}/options/{optionId}
Summary: catalog Product Custom Option Repository V1Delete By Identifier Delete
catalog Product Custom Option Repository V1Delete By Identifier Delete
OpenAPI snippet URL
PARAMETERS /V1/products/{sku}/options/{optionId}
OpenAPI snippet URL
GET /V1/products/{sku}/options
Summary: catalog Product Custom Option Repository V1Get List Get
Get the list of custom options for a specific product
OpenAPI snippet URL
PARAMETERS /V1/products/{sku}/options
OpenAPI snippet URL
PUT /V1/products/{sku}/websites
Summary: catalog Product Website Link Repository V1Save Put
Assign a product to the website
OpenAPI snippet URL
POST /V1/products/{sku}/websites
Summary: catalog Product Website Link Repository V1Save Post
Assign a product to the website
OpenAPI snippet URL
PARAMETERS /V1/products/{sku}/websites
OpenAPI snippet URL
DELETE /V1/products/{sku}/websites/{websiteId}
Summary: catalog Product Website Link Repository V1Delete By Id Delete
Remove the website assignment from the product by product sku
OpenAPI snippet URL
PARAMETERS /V1/products/{sku}/websites/{websiteId}
OpenAPI snippet URL
GET /V1/products/{sku}
Summary: catalog Product Repository V1Get Get
Get info about product by product SKU
OpenAPI snippet URL
PUT /V1/products/{sku}
Summary: catalog Product Repository V1Save Put
Create product
OpenAPI snippet URL
DELETE /V1/products/{sku}
Summary: catalog Product Repository V1Delete By Id Delete
catalog Product Repository V1Delete By Id Delete
OpenAPI snippet URL
PARAMETERS /V1/products/{sku}
OpenAPI snippet URL
GET /V1/products
Summary: catalog Product Repository V1Get List Get
Get product list
OpenAPI snippet URL
POST /V1/products
Summary: catalog Product Repository V1Save Post
Create product
OpenAPI snippet URL
GET /V1/products/media/types/{attributeSetName}
Summary: catalog Product Media Attribute Management V1Get List Get
Retrieve the list of media attributes (fronted input type is media_image) assigned to the given attribute set.
OpenAPI snippet URL
PARAMETERS /V1/products/media/types/{attributeSetName}
OpenAPI snippet URL
GET /V1/products/types
Summary: catalog Product Type List V1Get Product Types Get
Retrieve available product types
OpenAPI snippet URL
PUT /V1/products/{productSku}/stockItems/{itemId}
Summary: catalog Inventory Stock Registry V1Update Stock Item By Sku Put
catalog Inventory Stock Registry V1Update Stock Item By Sku Put
OpenAPI snippet URL
PARAMETERS /V1/products/{productSku}/stockItems/{itemId}
OpenAPI snippet URL
GET /V1/returns/{id}/comments
Summary: rma Comment Management V1Comments List Get
Comments list
OpenAPI snippet URL
POST /V1/returns/{id}/comments
Summary: rma Comment Management V1Add Comment Post
Add comment
OpenAPI snippet URL
PARAMETERS /V1/returns/{id}/comments
OpenAPI snippet URL
GET /V1/returns/{id}/tracking-numbers
Summary: rma Track Management V1Get Tracks Get
Get track list
OpenAPI snippet URL
POST /V1/returns/{id}/tracking-numbers
Summary: rma Track Management V1Add Track Post
Add track
OpenAPI snippet URL
PARAMETERS /V1/returns/{id}/tracking-numbers
OpenAPI snippet URL
DELETE /V1/returns/{id}/tracking-numbers/{trackId}
Summary: rma Track Management V1Remove Track By Id Delete
Remove track by id
OpenAPI snippet URL
PARAMETERS /V1/returns/{id}/tracking-numbers/{trackId}
OpenAPI snippet URL
GET /V1/returns/{id}
Summary: rma Rma Repository V1Get Get
Return data object for specified RMA id
OpenAPI snippet URL
PUT /V1/returns/{id}
Summary: rma Rma Management V1Save Rma Put
Save RMA
OpenAPI snippet URL
DELETE /V1/returns/{id}
Summary: rma Rma Repository V1Delete Delete
Delete RMA
OpenAPI snippet URL
PARAMETERS /V1/returns/{id}
OpenAPI snippet URL
GET /V1/returns/{id}/labels
Summary: rma Track Management V1Get Shipping Label Pdf Get
Get shipping label int the PDF format
OpenAPI snippet URL
PARAMETERS /V1/returns/{id}/labels
OpenAPI snippet URL
GET /V1/returns
Summary: rma Rma Management V1Search Get
Return list of rma data objects based on search criteria
OpenAPI snippet URL
POST /V1/returns
Summary: rma Rma Management V1Save Rma Post
Save RMA
OpenAPI snippet URL
GET /V1/returnsAttributeMetadata
Summary: rma Rma Attributes Management V1Get All Attributes Metadata Get
Get all attribute metadata.
OpenAPI snippet URL
GET /V1/returnsAttributeMetadata/custom
Summary: rma Rma Attributes Management V1Get Custom Attributes Metadata Get
Get custom attribute metadata for the given Data object’s attribute set
OpenAPI snippet URL
GET /V1/returnsAttributeMetadata/form/{formCode}
Summary: rma Rma Attributes Management V1Get Attributes Get
Retrieve all attributes filtered by form code
OpenAPI snippet URL
PARAMETERS /V1/returnsAttributeMetadata/form/{formCode}
OpenAPI snippet URL
GET /V1/returnsAttributeMetadata/{attributeCode}
Summary: rma Rma Attributes Management V1Get Attribute Metadata Get
Retrieve attribute metadata.
OpenAPI snippet URL
PARAMETERS /V1/returnsAttributeMetadata/{attributeCode}
OpenAPI snippet URL
GET /V1/salesRules/{ruleId}
Summary: sales Rule Rule Repository V1Get By Id Get
Get rule by ID.
OpenAPI snippet URL
PUT /V1/salesRules/{ruleId}
Summary: sales Rule Rule Repository V1Save Put
Save sales rule.
OpenAPI snippet URL
DELETE /V1/salesRules/{ruleId}
Summary: sales Rule Rule Repository V1Delete By Id Delete
Delete rule by ID.
OpenAPI snippet URL
PARAMETERS /V1/salesRules/{ruleId}
OpenAPI snippet URL
POST /V1/salesRules
Summary: sales Rule Rule Repository V1Save Post
Save sales rule.
OpenAPI snippet URL
GET /V1/salesRules/search
Summary: sales Rule Rule Repository V1Get List Get
Retrieve sales rules that match te specified criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#RuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.
OpenAPI snippet URL
POST /V1/shipment/track
Summary: sales Shipment Track Repository V1Save Post
Performs persist operations for a specified shipment track.
OpenAPI snippet URL
DELETE /V1/shipment/track/{id}
Summary: sales Shipment Track Repository V1Delete By Id Delete
Deletes a specified shipment track by ID.
OpenAPI snippet URL
PARAMETERS /V1/shipment/track/{id}
OpenAPI snippet URL
GET /V1/shipment/{id}/comments
Summary: sales Shipment Management V1Get Comments List Get
Lists comments for a specified shipment.
OpenAPI snippet URL
POST /V1/shipment/{id}/comments
Summary: sales Shipment Comment Repository V1Save Post
Performs persist operations for a specified shipment comment.
OpenAPI snippet URL
PARAMETERS /V1/shipment/{id}/comments
OpenAPI snippet URL
GET /V1/shipment/{id}
Summary: sales Shipment Repository V1Get Get
Loads a specified shipment.
OpenAPI snippet URL
PARAMETERS /V1/shipment/{id}
OpenAPI snippet URL
POST /V1/shipment/{id}/emails
Summary: sales Shipment Management V1Notify Post
Emails user a specified shipment.
OpenAPI snippet URL
PARAMETERS /V1/shipment/{id}/emails
OpenAPI snippet URL
GET /V1/shipment/{id}/label
Summary: sales Shipment Management V1Get Label Get
Gets a specified shipment label.
OpenAPI snippet URL
PARAMETERS /V1/shipment/{id}/label
OpenAPI snippet URL
POST /V1/shipment/
Summary: sales Shipment Repository V1Save Post
Performs persist operations for a specified shipment.
OpenAPI snippet URL
GET /V1/stockItems/lowStock/
Summary: catalog Inventory Stock Registry V1Get Low Stock Items Get
Retrieves a list of SKU’s with low inventory qty
OpenAPI snippet URL
GET /V1/stockItems/{productSku}
Summary: catalog Inventory Stock Registry V1Get Stock Item By Sku Get
catalog Inventory Stock Registry V1Get Stock Item By Sku Get
OpenAPI snippet URL
PARAMETERS /V1/stockItems/{productSku}
OpenAPI snippet URL
GET /V1/store/storeConfigs
Summary: store Store Config Manager V1Get Store Configs Get
store Store Config Manager V1Get Store Configs Get
OpenAPI snippet URL
GET /V1/store/storeGroups
Summary: store Group Repository V1Get List Get
Retrieve list of all groups
OpenAPI snippet URL
GET /V1/store/storeViews
Summary: store Store Repository V1Get List Get
Retrieve list of all stores
OpenAPI snippet URL
GET /V1/store/websites
Summary: store Website Repository V1Get List Get
Retrieve list of all websites
OpenAPI snippet URL
GET /V1/taxClasses/{taxClassId}
Summary: tax Tax Class Repository V1Get Get
Get a tax class with the given tax class id.
OpenAPI snippet URL
DELETE /V1/taxClasses/{taxClassId}
Summary: tax Tax Class Repository V1Delete By Id Delete
Delete a tax class with the given tax class id.
OpenAPI snippet URL
PARAMETERS /V1/taxClasses/{taxClassId}
OpenAPI snippet URL
POST /V1/taxClasses
Summary: tax Tax Class Repository V1Save Post
Create a Tax Class
OpenAPI snippet URL
GET /V1/taxClasses/search
Summary: tax Tax Class Repository V1Get List Get
Retrieve tax classes which match a specific criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#TaxClassRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.
OpenAPI snippet URL
PUT /V1/taxClasses/{classId}
Summary: tax Tax Class Repository V1Save Put
Create a Tax Class
OpenAPI snippet URL
PARAMETERS /V1/taxClasses/{classId}
OpenAPI snippet URL
GET /V1/taxRates/{rateId}
Summary: tax Tax Rate Repository V1Get Get
Get tax rate
OpenAPI snippet URL
DELETE /V1/taxRates/{rateId}
Summary: tax Tax Rate Repository V1Delete By Id Delete
Delete tax rate
OpenAPI snippet URL
PARAMETERS /V1/taxRates/{rateId}
OpenAPI snippet URL
PUT /V1/taxRates
Summary: tax Tax Rate Repository V1Save Put
Create or update tax rate
OpenAPI snippet URL
POST /V1/taxRates
Summary: tax Tax Rate Repository V1Save Post
Create or update tax rate
OpenAPI snippet URL
GET /V1/taxRates/search
Summary: tax Tax Rate Repository V1Get List Get
Search TaxRates This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#TaxRateRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.
OpenAPI snippet URL
GET /V1/taxRules/{ruleId}
Summary: tax Tax Rule Repository V1Get Get
Get TaxRule
OpenAPI snippet URL
DELETE /V1/taxRules/{ruleId}
Summary: tax Tax Rule Repository V1Delete By Id Delete
Delete TaxRule
OpenAPI snippet URL
PARAMETERS /V1/taxRules/{ruleId}
OpenAPI snippet URL
PUT /V1/taxRules
Summary: tax Tax Rule Repository V1Save Put
Save TaxRule
OpenAPI snippet URL
POST /V1/taxRules
Summary: tax Tax Rule Repository V1Save Post
Save TaxRule
OpenAPI snippet URL
GET /V1/taxRules/search
Summary: tax Tax Rule Repository V1Get List Get
Search TaxRules This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#TaxRuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.
OpenAPI snippet URL
GET /V1/transactions
Summary: sales Transaction Repository V1Get List Get
Lists transactions that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#TransactionRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.
OpenAPI snippet URL
GET /V1/transactions/{id}
Summary: sales Transaction Repository V1Get Get
Loads a specified transaction.
OpenAPI snippet URL
PARAMETERS /V1/transactions/{id}
OpenAPI snippet URL
DELETE /V1/addresses/{addressId}
Summary: customer Address Repository V1Delete By Id Delete
Delete customer address by ID.
OpenAPI snippet URL
PARAMETERS /V1/addresses/{addressId}
OpenAPI snippet URL
GET /V1/creditmemos
Summary: sales Creditmemo Repository V1Get List Get
Lists credit memos that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#CreditmemoRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.
OpenAPI snippet URL
POST /V1/giftregistry/mine/estimate-shipping-methods
Summary: gift Registry Shipping Method Management V1Estimate By Registry Id Post
Estimate shipping
OpenAPI snippet URL
POST /V1/guest-giftregistry/{cartId}/estimate-shipping-methods
Summary: gift Registry Guest Cart Shipping Method Management V1Estimate By Registry Id Post
Estimate shipping
OpenAPI snippet URL
PARAMETERS /V1/guest-giftregistry/{cartId}/estimate-shipping-methods
OpenAPI snippet URL
POST /V1/invoice/{invoiceId}/refund
Summary: sales Refund Invoice V1Execute Post
Create refund for invoice
OpenAPI snippet URL
PARAMETERS /V1/invoice/{invoiceId}/refund
OpenAPI snippet URL
GET /V1/modules
Summary: backend Module Service V1Get Modules Get
Returns an array of enabled modules
OpenAPI snippet URL
POST /V1/reward/mine/use-reward
Summary: reward Reward Management V1Set Post
Set reward points to quote
OpenAPI snippet URL
GET /V1/search
Summary: search V1Search Get
Make Full Text Search and return found Documents
OpenAPI snippet URL
GET /V1/shipments
Summary: sales Shipment Repository V1Get List Get
Lists shipments that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#ShipmentRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.
OpenAPI snippet URL
GET /V1/stockStatuses/{productSku}
Summary: catalog Inventory Stock Registry V1Get Stock Status By Sku Get
catalog Inventory Stock Registry V1Get Stock Status By Sku Get
OpenAPI snippet URL
PARAMETERS /V1/stockStatuses/{productSku}
OpenAPI snippet URL
POST /V1/worldpay-guest-carts/{cartId}/payment-information
Summary: worldpay Guest Payment Information Management Proxy V1Save Payment Information And Place Order Post
Proxy handler for guest place order
OpenAPI snippet URL
PARAMETERS /V1/worldpay-guest-carts/{cartId}/payment-information
OpenAPI snippet URL