Search Link: https://www.google.com/search?channel=fs&client=ubuntu-sn&q=postman+collection+35240-71bcaea5-db45-42d9-b70f-6e41154f615d

Overview

GET /V1/attributeMetadata/customer

Summary: customer Customer Metadata V1Get All Attributes Metadata Get

Get all attribute metadata.


GET /V1/attributeMetadata/customer/attribute/{attributeCode}

Summary: customer Customer Metadata V1Get Attribute Metadata Get

Retrieve attribute metadata.


PARAMETERS /V1/attributeMetadata/customer/attribute/{attributeCode}


GET /V1/attributeMetadata/customer/custom

Summary: customer Customer Metadata V1Get Custom Attributes Metadata Get

Get custom attributes metadata for the given data interface.


GET /V1/attributeMetadata/customer/form/{formCode}

Summary: customer Customer Metadata V1Get Attributes Get

Retrieve all attributes filtered by form code


PARAMETERS /V1/attributeMetadata/customer/form/{formCode}


GET /V1/attributeMetadata/customerAddress

Summary: customer Address Metadata V1Get All Attributes Metadata Get

Get all attribute metadata.


GET /V1/attributeMetadata/customerAddress/attribute/{attributeCode}

Summary: customer Address Metadata V1Get Attribute Metadata Get

Retrieve attribute metadata.


PARAMETERS /V1/attributeMetadata/customerAddress/attribute/{attributeCode}


GET /V1/attributeMetadata/customerAddress/custom

Summary: customer Address Metadata V1Get Custom Attributes Metadata Get

Get custom attributes metadata for the given data interface.


GET /V1/attributeMetadata/customerAddress/form/{formCode}

Summary: customer Address Metadata V1Get Attributes Get

Retrieve all attributes filtered by form code


PARAMETERS /V1/attributeMetadata/customerAddress/form/{formCode}


POST /V1/bundle-products/options/add

Summary: bundle Product Option Management V1Save Post

Add new option for bundle product


GET /V1/bundle-products/options/types

Summary: bundle Product Option Type List V1Get Items Get

Get all types for options for bundle products


PUT /V1/bundle-products/options/{optionId}

Summary: bundle Product Option Management V1Save Put

Add new option for bundle product


PARAMETERS /V1/bundle-products/options/{optionId}


PUT /V1/bundle-products/{sku}/links/{id}

Summary: bundle Product Link Management V1Save Child Put

bundle Product Link Management V1Save Child Put


PARAMETERS /V1/bundle-products/{sku}/links/{id}


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


PARAMETERS /V1/bundle-products/{sku}/links/{optionId}


GET /V1/bundle-products/{sku}/options/{optionId}

Summary: bundle Product Option Repository V1Get Get

Get option for bundle product


DELETE /V1/bundle-products/{sku}/options/{optionId}

Summary: bundle Product Option Repository V1Delete By Id Delete

Remove bundle option


PARAMETERS /V1/bundle-products/{sku}/options/{optionId}


DELETE /V1/bundle-products/{sku}/options/{optionId}/children/{childSku}

Summary: bundle Product Link Management V1Remove Child Delete

Remove product from Bundle product option


PARAMETERS /V1/bundle-products/{sku}/options/{optionId}/children/{childSku}


GET /V1/bundle-products/{sku}/options/all

Summary: bundle Product Option Repository V1Get List Get

Get all options for bundle product


PARAMETERS /V1/bundle-products/{sku}/options/all


GET /V1/bundle-products/{productSku}/children

Summary: bundle Product Link Management V1Get Children Get

Get all children for Bundle product


PARAMETERS /V1/bundle-products/{productSku}/children


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


PARAMETERS /V1/carts/guest-carts/{cartId}/giftCards


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


PARAMETERS /V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}


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


PARAMETERS /V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}


GET /V1/carts/mine/billing-address

Summary: /V1/carts/mine/billing-address

Returns the billing address for a specified quote.


POST /V1/carts/mine/billing-address

Summary: /V1/carts/mine/billing-address

Assigns a specified billing address to a specified cart.


GET /V1/carts/mine/coupons

Summary: /V1/carts/mine/coupons

Returns information for a coupon in a specified cart.


DELETE /V1/carts/mine/coupons

Summary: /V1/carts/mine/coupons

Deletes a coupon from a specified cart.


PUT /V1/carts/mine/coupons/{couponCode}

Summary: /V1/carts/mine/coupons/:couponCode

Adds a coupon by code to a specified cart.


PARAMETERS /V1/carts/mine/coupons/{couponCode}


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.


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.


PARAMETERS /V1/carts/mine/gift-message/{itemId}


GET /V1/carts/mine/gift-message

Summary: /V1/carts/mine/gift-message

Return the gift message for a specified order.


POST /V1/carts/mine/gift-message

Summary: /V1/carts/mine/gift-message

Set the gift message for an entire order.


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


DELETE /V1/carts/mine/giftCards/{giftCardCode}

Summary: /V1/carts/mine/giftCards/:giftCardCode

Remove GiftCard Account entity


PARAMETERS /V1/carts/mine/giftCards/{giftCardCode}


PUT /V1/carts/mine/items/{itemId}

Summary: /V1/carts/mine/items/:itemId

Add/update the specified cart item.


DELETE /V1/carts/mine/items/{itemId}

Summary: /V1/carts/mine/items/:itemId

Removes the specified item from the specified cart.


PARAMETERS /V1/carts/mine/items/{itemId}


GET /V1/carts/mine/items

Summary: /V1/carts/mine/items

Lists items that are assigned to a specified cart.


POST /V1/carts/mine/items

Summary: /V1/carts/mine/items

Add/update the specified cart item.


GET /V1/carts/mine/payment-information

Summary: checkout Payment Information Management V1Get Payment Information Get

Get payment information


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.


GET /V1/carts/mine/selected-payment-method

Summary: /V1/carts/mine/selected-payment-method

Returns the payment method for a specified shopping cart.


PUT /V1/carts/mine/selected-payment-method

Summary: /V1/carts/mine/selected-payment-method

Adds a specified payment method to a specified shopping cart.


GET /V1/carts/mine

Summary: quote Cart Management V1Get Cart For Customer Get

Returns information for the cart for a specified customer.


PUT /V1/carts/mine

Summary: quote Cart Repository V1Save Put

Save quote


POST /V1/carts/mine

Summary: /V1/carts/mine

Creates an empty cart and quote for a specified customer.


POST /V1/carts/mine/balance/apply

Summary: customer Balance Balance Management V1Apply Post

Apply store credit


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


PARAMETERS /V1/carts/mine/checkGiftCard/{giftCardCode}


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.


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


POST /V1/carts/mine/estimate-shipping-methods-by-address-id

Summary: /V1/carts/mine/estimate-shipping-methods-by-address-id

Estimate shipping


PUT /V1/carts/mine/order

Summary: /V1/carts/mine/order

Places an order for a specified cart.


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.


POST /V1/carts/mine/set-payment-information

Summary: checkout Payment Information Management V1Save Payment Information Post

Set payment information for a specified cart.


POST /V1/carts/mine/shipping-information

Summary: /V1/carts/mine/shipping-information

/V1/carts/mine/shipping-information


GET /V1/carts/mine/shipping-methods

Summary: /V1/carts/mine/shipping-methods

Lists applicable shipping methods for a specified quote.


GET /V1/carts/mine/totals

Summary: /V1/carts/mine/totals

Returns quote totals data for a specified cart.


POST /V1/carts/mine/totals-information

Summary: /V1/carts/mine/totals-information

Calculate quote totals based on address and shipping method.


GET /V1/carts/{cartId}/billing-address

Summary: /V1/carts/:cartId/billing-address

Returns the billing address for a specified quote.


POST /V1/carts/{cartId}/billing-address

Summary: /V1/carts/:cartId/billing-address

Assigns a specified billing address to a specified cart.


PARAMETERS /V1/carts/{cartId}/billing-address


GET /V1/carts/{cartId}/coupons

Summary: /V1/carts/:cartId/coupons

Returns information for a coupon in a specified cart.


DELETE /V1/carts/{cartId}/coupons

Summary: /V1/carts/:cartId/coupons

Deletes a coupon from a specified cart.


PARAMETERS /V1/carts/{cartId}/coupons


PUT /V1/carts/{cartId}/coupons/{couponCode}

Summary: /V1/carts/:cartId/coupons/:couponCode

Adds a coupon by code to a specified cart.


PARAMETERS /V1/carts/{cartId}/coupons/{couponCode}


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.


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.


PARAMETERS /V1/carts/{cartId}/gift-message/{itemId}


GET /V1/carts/{cartId}/gift-message

Summary: /V1/carts/:cartId/gift-message

Return the gift message for a specified order.


POST /V1/carts/{cartId}/gift-message

Summary: /V1/carts/:cartId/gift-message

Set the gift message for an entire order.


PARAMETERS /V1/carts/{cartId}/gift-message


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


PARAMETERS /V1/carts/{cartId}/giftCards


DELETE /V1/carts/{cartId}/giftCards/{giftCardCode}

Summary: /V1/carts/:cartId/giftCards/:giftCardCode

Remove GiftCard Account entity


PARAMETERS /V1/carts/{cartId}/giftCards/{giftCardCode}


PUT /V1/carts/{cartId}/items/{itemId}

Summary: /V1/carts/:cartId/items/:itemId

Add/update the specified cart item.


DELETE /V1/carts/{cartId}/items/{itemId}

Summary: /V1/carts/:cartId/items/:itemId

Removes the specified item from the specified cart.


PARAMETERS /V1/carts/{cartId}/items/{itemId}


GET /V1/carts/{cartId}/items

Summary: /V1/carts/:cartId/items

Lists items that are assigned to a specified cart.


PARAMETERS /V1/carts/{cartId}/items


GET /V1/carts/{cartId}/selected-payment-method

Summary: /V1/carts/:cartId/selected-payment-method

Returns the payment method for a specified shopping cart.


PUT /V1/carts/{cartId}/selected-payment-method

Summary: /V1/carts/:cartId/selected-payment-method

Adds a specified payment method to a specified shopping cart.


PARAMETERS /V1/carts/{cartId}/selected-payment-method


GET /V1/carts/{cartId}

Summary: quote Cart Repository V1Get Get

Enables an administrative user to return information for a specified cart.


PUT /V1/carts/{cartId}

Summary: quote Cart Management V1Assign Customer Put

Assigns a specified customer to a specified shopping cart.


PARAMETERS /V1/carts/{cartId}


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


PARAMETERS /V1/carts/{cartId}/estimate-shipping-methods


POST /V1/carts/{cartId}/estimate-shipping-methods-by-address-id

Summary: /V1/carts/:cartId/estimate-shipping-methods-by-address-id

Estimate shipping


PARAMETERS /V1/carts/{cartId}/estimate-shipping-methods-by-address-id


PUT /V1/carts/{cartId}/order

Summary: /V1/carts/:cartId/order

Places an order for a specified cart.


PARAMETERS /V1/carts/{cartId}/order


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.


PARAMETERS /V1/carts/{cartId}/payment-methods


POST /V1/carts/{cartId}/shipping-information

Summary: /V1/carts/:cartId/shipping-information

/V1/carts/:cartId/shipping-information


PARAMETERS /V1/carts/{cartId}/shipping-information


GET /V1/carts/{cartId}/shipping-methods

Summary: /V1/carts/:cartId/shipping-methods

Lists applicable shipping methods for a specified quote.


PARAMETERS /V1/carts/{cartId}/shipping-methods


GET /V1/carts/{cartId}/totals

Summary: /V1/carts/:cartId/totals

Returns quote totals data for a specified cart.


PARAMETERS /V1/carts/{cartId}/totals


POST /V1/carts/{cartId}/totals-information

Summary: /V1/carts/:cartId/totals-information

Calculate quote totals based on address and shipping method.


PARAMETERS /V1/carts/{cartId}/totals-information


GET /V1/carts/{quoteId}/giftCards

Summary: gift Card Account Gift Card Account Management V1Get List By Quote Id Get

Return GiftCard Account cards


PARAMETERS /V1/carts/{quoteId}/giftCards


POST /V1/carts/{quoteId}/items

Summary: /V1/carts/:quoteId/items

Add/update the specified cart item.


PARAMETERS /V1/carts/{quoteId}/items


POST /V1/carts/

Summary: quote Cart Management V1Create Empty Cart Post

Creates an empty cart and quote for a guest.


GET /V1/carts/licence

Summary: checkout Agreements Checkout Agreements Repository V1Get List Get

Lists active checkout agreements.


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.


GET /V1/categories/attributes/{attributeCode}

Summary: catalog Category Attribute Repository V1Get Get

Retrieve specific attribute


PARAMETERS /V1/categories/attributes/{attributeCode}


GET /V1/categories/attributes/{attributeCode}/options

Summary: catalog Category Attribute Option Management V1Get Items Get

Retrieve list of attribute options


PARAMETERS /V1/categories/attributes/{attributeCode}/options


GET /V1/categories/attributes

Summary: catalog Category Attribute Repository V1Get List Get

Retrieve all attributes for entity type


GET /V1/categories/{categoryId}/products

Summary: catalog Category Link Management V1Get Assigned Products Get

Get products assigned to category


PUT /V1/categories/{categoryId}/products

Summary: catalog Category Link Repository V1Save Put

Assign a product to the required category


POST /V1/categories/{categoryId}/products

Summary: catalog Category Link Repository V1Save Post

Assign a product to the required category


PARAMETERS /V1/categories/{categoryId}/products


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


PARAMETERS /V1/categories/{categoryId}/products/{sku}


GET /V1/categories/{categoryId}

Summary: catalog Category Repository V1Get Get

Get info about category by category id


DELETE /V1/categories/{categoryId}

Summary: catalog Category Repository V1Delete By Identifier Delete

Delete category by identifier


PARAMETERS /V1/categories/{categoryId}


PUT /V1/categories/{categoryId}/move

Summary: catalog Category Management V1Move Put

Move category


PARAMETERS /V1/categories/{categoryId}/move


GET /V1/categories

Summary: catalog Category Management V1Get Tree Get

Retrieve list of categories


POST /V1/categories

Summary: catalog Category Repository V1Save Post

Create category service


PUT /V1/categories/{id}

Summary: catalog Category Repository V1Save Put

Create category service


PARAMETERS /V1/categories/{id}


GET /V1/cmsBlock/{blockId}

Summary: cms Block Repository V1Get By Id Get

Retrieve block.


DELETE /V1/cmsBlock/{blockId}

Summary: cms Block Repository V1Delete By Id Delete

Delete block by ID.


PARAMETERS /V1/cmsBlock/{blockId}


POST /V1/cmsBlock

Summary: cms Block Repository V1Save Post

Save block.


GET /V1/cmsBlock/search

Summary: cms Block Repository V1Get List Get

Retrieve blocks matching the specified criteria.


PUT /V1/cmsBlock/{id}

Summary: cms Block Repository V1Save Put

Save block.


PARAMETERS /V1/cmsBlock/{id}


GET /V1/cmsPage/{pageId}

Summary: cms Page Repository V1Get By Id Get

Retrieve page.


DELETE /V1/cmsPage/{pageId}

Summary: cms Page Repository V1Delete By Id Delete

Delete page by ID.


PARAMETERS /V1/cmsPage/{pageId}


POST /V1/cmsPage

Summary: cms Page Repository V1Save Post

Save page.


GET /V1/cmsPage/search

Summary: cms Page Repository V1Get List Get

Retrieve pages matching the specified criteria.


PUT /V1/cmsPage/{id}

Summary: cms Page Repository V1Save Put

Save page.


PARAMETERS /V1/cmsPage/{id}


GET /V1/configurable-products/{sku}/children

Summary: configurable Product Link Management V1Get Children Get

Get all children for Configurable product


PARAMETERS /V1/configurable-products/{sku}/children


DELETE /V1/configurable-products/{sku}/children/{childSku}

Summary: configurable Product Link Management V1Remove Child Delete

Remove configurable product option


PARAMETERS /V1/configurable-products/{sku}/children/{childSku}


GET /V1/configurable-products/{sku}/options/{id}

Summary: configurable Product Option Repository V1Get Get

Get option for configurable product


PUT /V1/configurable-products/{sku}/options/{id}

Summary: configurable Product Option Repository V1Save Put

Save option


DELETE /V1/configurable-products/{sku}/options/{id}

Summary: configurable Product Option Repository V1Delete By Id Delete

Remove option from configurable product


PARAMETERS /V1/configurable-products/{sku}/options/{id}


POST /V1/configurable-products/{sku}/options

Summary: configurable Product Option Repository V1Save Post

Save option


PARAMETERS /V1/configurable-products/{sku}/options


GET /V1/configurable-products/{sku}/options/all

Summary: configurable Product Option Repository V1Get List Get

Get all options for configurable product


PARAMETERS /V1/configurable-products/{sku}/options/all


POST /V1/configurable-products/{sku}/child

Summary: configurable Product Link Management V1Add Child Post

configurable Product Link Management V1Add Child Post


PARAMETERS /V1/configurable-products/{sku}/child


PUT /V1/configurable-products/variation

Summary: configurable Product Configurable Product Management V1Generate Variation Put

Generate variation based on same product


GET /V1/coupons/{couponId}

Summary: sales Rule Coupon Repository V1Get By Id Get

Get coupon by coupon id.


PUT /V1/coupons/{couponId}

Summary: sales Rule Coupon Repository V1Save Put

Save a coupon.


DELETE /V1/coupons/{couponId}

Summary: sales Rule Coupon Repository V1Delete By Id Delete

Delete coupon by coupon id.


PARAMETERS /V1/coupons/{couponId}


POST /V1/coupons

Summary: sales Rule Coupon Repository V1Save Post

Save a coupon.


POST /V1/coupons/deleteByCodes

Summary: sales Rule Coupon Management V1Delete By Codes Post

Delete coupon by coupon codes.


POST /V1/coupons/deleteByIds

Summary: sales Rule Coupon Management V1Delete By Ids Post

Delete coupon by coupon ids.


POST /V1/coupons/generate

Summary: sales Rule Coupon Management V1Generate Post

Generate coupon for a rule


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.


GET /V1/creditmemo/{id}/comments

Summary: sales Creditmemo Management V1Get Comments List Get

Lists comments for a specified credit memo.


POST /V1/creditmemo/{id}/comments

Summary: sales Creditmemo Comment Repository V1Save Post

Performs persist operations for a specified entity.


PARAMETERS /V1/creditmemo/{id}/comments


GET /V1/creditmemo/{id}

Summary: sales Creditmemo Repository V1Get Get

Loads a specified credit memo.


PUT /V1/creditmemo/{id}

Summary: sales Creditmemo Management V1Cancel Put

Cancels a specified credit memo.


PARAMETERS /V1/creditmemo/{id}


POST /V1/creditmemo/{id}/emails

Summary: sales Creditmemo Management V1Notify Post

Emails a user a specified credit memo.


PARAMETERS /V1/creditmemo/{id}/emails


POST /V1/creditmemo

Summary: sales Creditmemo Repository V1Save Post

Performs persist operations for a specified credit memo.


POST /V1/creditmemo/refund

Summary: sales Creditmemo Management V1Refund Post

Prepare creditmemo to refund and save it.


GET /V1/customerGroups/default

Summary: /V1/customerGroups/default

Get default customer group.


GET /V1/customerGroups/default/{storeId}

Summary: /V1/customerGroups/default/:storeId

Get default customer group.


PARAMETERS /V1/customerGroups/default/{storeId}


GET /V1/customerGroups/{id}

Summary: customer Group Repository V1Get By Id Get

Get customer group by group ID.


PUT /V1/customerGroups/{id}

Summary: customer Group Repository V1Save Put

Save customer group.


DELETE /V1/customerGroups/{id}

Summary: customer Group Repository V1Delete By Id Delete

Delete customer group by ID.


PARAMETERS /V1/customerGroups/{id}


GET /V1/customerGroups/{id}/permissions

Summary: customer Group Management V1Is Readonly Get

Check if customer group can be deleted.


PARAMETERS /V1/customerGroups/{id}/permissions


POST /V1/customerGroups

Summary: customer Group Repository V1Save Post

Save customer group.


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.


GET /V1/customers/me

Summary: /V1/customers/me

Get customer by customer ID.


PUT /V1/customers/me

Summary: /V1/customers/me

Create or update a customer.


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.


GET /V1/customers/me/billingAddress

Summary: /V1/customers/me/billingAddress

Retrieve default billing address for the given customerId.


PUT /V1/customers/me/password

Summary: customer Account Management V1Change Password By Id Put

Change customer password.


GET /V1/customers/me/shippingAddress

Summary: /V1/customers/me/shippingAddress

Retrieve default shipping address for the given customerId.


GET /V1/customers/{customerId}

Summary: /V1/customers/:customerId

Get customer by customer ID.


DELETE /V1/customers/{customerId}

Summary: customer Customer Repository V1Delete By Id Delete

Delete customer by ID.


PARAMETERS /V1/customers/{customerId}


GET /V1/customers/{customerId}/billingAddress

Summary: /V1/customers/:customerId/billingAddress

Retrieve default billing address for the given customerId.


PARAMETERS /V1/customers/{customerId}/billingAddress


POST /V1/customers/{customerId}/carts

Summary: /V1/customers/:customerId/carts

Creates an empty cart and quote for a specified customer.


PARAMETERS /V1/customers/{customerId}/carts


GET /V1/customers/{customerId}/confirm

Summary: customer Account Management V1Get Confirmation Status Get

Gets the account confirmation status.


PARAMETERS /V1/customers/{customerId}/confirm


GET /V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}

Summary: customer Account Management V1Validate Reset Password Link Token Get

Check if password reset token is valid.


PARAMETERS /V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}


GET /V1/customers/{customerId}/permissions/readonly

Summary: customer Account Management V1Is Readonly Get

Check if customer can be deleted.


PARAMETERS /V1/customers/{customerId}/permissions/readonly


GET /V1/customers/{customerId}/shippingAddress

Summary: /V1/customers/:customerId/shippingAddress

Retrieve default shipping address for the given customerId.


PARAMETERS /V1/customers/{customerId}/shippingAddress


POST /V1/customers

Summary: customer Account Management V1Create Account Post

Create customer account. Perform necessary business operations like sending email.


GET /V1/customers/addresses/{addressId}

Summary: customer Address Repository V1Get By Id Get

Retrieve customer address.


PARAMETERS /V1/customers/addresses/{addressId}


POST /V1/customers/confirm

Summary: customer Account Management V1Resend Confirmation Post

Resend confirmation email.


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.


PUT /V1/customers/password

Summary: customer Account Management V1Initiate Password Reset Put

Send an email to the customer with a password reset link.


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.


PUT /V1/customers/validate

Summary: customer Account Management V1Validate Put

Validate customer data.


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.


PARAMETERS /V1/customers/{email}/activate


PUT /V1/customers/{id}

Summary: /V1/customers/:id

Create or update a customer.


PARAMETERS /V1/customers/{id}


GET /V1/directory/countries

Summary: directory Country Information Acquirer V1Get Countries Info Get

Get all countries and regions information for the store.


GET /V1/directory/countries/{countryId}

Summary: directory Country Information Acquirer V1Get Country Info Get

Get country and region information for the store.


PARAMETERS /V1/directory/countries/{countryId}


GET /V1/directory/currency

Summary: directory Currency Information Acquirer V1Get Currency Info Get

Get currency information for the store.


GET /V1/eav/attribute-sets/{attributeSetId}

Summary: eav Attribute Set Repository V1Get Get

Retrieve attribute set information based on given ID


PUT /V1/eav/attribute-sets/{attributeSetId}

Summary: eav Attribute Set Repository V1Save Put

Save attribute set data


DELETE /V1/eav/attribute-sets/{attributeSetId}

Summary: eav Attribute Set Repository V1Delete By Id Delete

Remove attribute set by given ID


PARAMETERS /V1/eav/attribute-sets/{attributeSetId}


POST /V1/eav/attribute-sets

Summary: eav Attribute Set Management V1Create Post

Create attribute set from data


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.


GET /V1/gift-wrappings/{id}

Summary: gift Wrapping Wrapping Repository V1Get Get

Return data object for specified wrapping ID and store.


DELETE /V1/gift-wrappings/{id}

Summary: gift Wrapping Wrapping Repository V1Delete By Id Delete

Delete gift wrapping


PARAMETERS /V1/gift-wrappings/{id}


GET /V1/gift-wrappings

Summary: gift Wrapping Wrapping Repository V1Get List Get

Return list of gift wrapping data objects based on search criteria


POST /V1/gift-wrappings

Summary: gift Wrapping Wrapping Repository V1Save Post

Create/Update new gift wrapping with data object values


PUT /V1/gift-wrappings/{wrappingId}

Summary: gift Wrapping Wrapping Repository V1Save Put

Create/Update new gift wrapping with data object values


PARAMETERS /V1/gift-wrappings/{wrappingId}


GET /V1/guest-carts/{cartId}/billing-address

Summary: quote Guest Billing Address Management V1Get Get

Return the billing address for a specified quote.


POST /V1/guest-carts/{cartId}/billing-address

Summary: quote Guest Billing Address Management V1Assign Post

Assign a specified billing address to a specified cart.


PARAMETERS /V1/guest-carts/{cartId}/billing-address


GET /V1/guest-carts/{cartId}/coupons

Summary: quote Guest Coupon Management V1Get Get

Return information for a coupon in a specified cart.


DELETE /V1/guest-carts/{cartId}/coupons

Summary: quote Guest Coupon Management V1Remove Delete

Delete a coupon from a specified cart.


PARAMETERS /V1/guest-carts/{cartId}/coupons


PUT /V1/guest-carts/{cartId}/coupons/{couponCode}

Summary: quote Guest Coupon Management V1Set Put

Add a coupon by code to a specified cart.


PARAMETERS /V1/guest-carts/{cartId}/coupons/{couponCode}


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.


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.


PARAMETERS /V1/guest-carts/{cartId}/gift-message/{itemId}


GET /V1/guest-carts/{cartId}/gift-message

Summary: gift Message Guest Cart Repository V1Get Get

Return the gift message for a specified order.


POST /V1/guest-carts/{cartId}/gift-message

Summary: gift Message Guest Cart Repository V1Save Post

Set the gift message for an entire order.


PARAMETERS /V1/guest-carts/{cartId}/gift-message


PUT /V1/guest-carts/{cartId}/items/{itemId}

Summary: quote Guest Cart Item Repository V1Save Put

Add the specified item to the specified cart.


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.


PARAMETERS /V1/guest-carts/{cartId}/items/{itemId}


GET /V1/guest-carts/{cartId}/items

Summary: quote Guest Cart Item Repository V1Get List Get

List items that are assigned to a specified cart.


POST /V1/guest-carts/{cartId}/items

Summary: quote Guest Cart Item Repository V1Save Post

Add the specified item to the specified cart.


PARAMETERS /V1/guest-carts/{cartId}/items


GET /V1/guest-carts/{cartId}/payment-information

Summary: checkout Guest Payment Information Management V1Get Payment Information Get

Get payment information


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.


PARAMETERS /V1/guest-carts/{cartId}/payment-information


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.


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.


PARAMETERS /V1/guest-carts/{cartId}/selected-payment-method


GET /V1/guest-carts/{cartId}

Summary: quote Guest Cart Repository V1Get Get

Enable a guest user to return information for a specified cart.


PUT /V1/guest-carts/{cartId}

Summary: quote Guest Cart Management V1Assign Customer Put

Assign a specified customer to a specified shopping cart.


PARAMETERS /V1/guest-carts/{cartId}


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.


PARAMETERS /V1/guest-carts/{cartId}/collect-totals


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


PARAMETERS /V1/guest-carts/{cartId}/estimate-shipping-methods


PUT /V1/guest-carts/{cartId}/order

Summary: quote Guest Cart Management V1Place Order Put

Place an order for a specified cart.


PARAMETERS /V1/guest-carts/{cartId}/order


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.


PARAMETERS /V1/guest-carts/{cartId}/payment-methods


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.


PARAMETERS /V1/guest-carts/{cartId}/set-payment-information


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


PARAMETERS /V1/guest-carts/{cartId}/shipping-information


GET /V1/guest-carts/{cartId}/shipping-methods

Summary: quote Guest Shipping Method Management V1Get List Get

List applicable shipping methods for a specified quote.


PARAMETERS /V1/guest-carts/{cartId}/shipping-methods


GET /V1/guest-carts/{cartId}/totals

Summary: quote Guest Cart Total Repository V1Get Get

Return quote totals data for a specified cart.


PARAMETERS /V1/guest-carts/{cartId}/totals


POST /V1/guest-carts/{cartId}/totals-information

Summary: checkout Guest Totals Information Management V1Calculate Post

Calculate quote totals based on address and shipping method.


PARAMETERS /V1/guest-carts/{cartId}/totals-information


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.


POST /V1/integration/admin/token

Summary: integration Admin Token Service V1Create Admin Access Token Post

Create access token for admin given the admin credentials.


POST /V1/integration/customer/token

Summary: integration Customer Token Service V1Create Customer Access Token Post

Create access token for admin given the customer credentials.


GET /V1/invoices/{id}

Summary: sales Invoice Repository V1Get Get

Loads a specified invoice.


PARAMETERS /V1/invoices/{id}


POST /V1/invoices/{id}/capture

Summary: sales Invoice Management V1Set Capture Post

Sets invoice capture.


PARAMETERS /V1/invoices/{id}/capture


GET /V1/invoices/{id}/comments

Summary: sales Invoice Management V1Get Comments List Get

Lists comments for a specified invoice.


PARAMETERS /V1/invoices/{id}/comments


POST /V1/invoices/{id}/emails

Summary: sales Invoice Management V1Notify Post

Emails a user a specified invoice.


PARAMETERS /V1/invoices/{id}/emails


POST /V1/invoices/{id}/void

Summary: sales Invoice Management V1Set Void Post

Voids a specified invoice.


PARAMETERS /V1/invoices/{id}/void


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.


POST /V1/invoices/

Summary: sales Invoice Repository V1Save Post

Performs persist operations for a specified invoice.


POST /V1/invoices/comments

Summary: sales Invoice Comment Repository V1Save Post

Performs persist operations for a specified invoice comment.


POST /V1/order/{orderId}/invoice

Summary: sales Invoice Order V1Execute Post

sales Invoice Order V1Execute Post


PARAMETERS /V1/order/{orderId}/invoice


POST /V1/order/{orderId}/refund

Summary: sales Refund Order V1Execute Post

Create offline refund for order


PARAMETERS /V1/order/{orderId}/refund


POST /V1/order/{orderId}/ship

Summary: sales Ship Order V1Execute Post

Creates new Shipment for given Order.


PARAMETERS /V1/order/{orderId}/ship


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.


GET /V1/orders/items/{id}

Summary: sales Order Item Repository V1Get Get

Loads a specified order item.


PARAMETERS /V1/orders/items/{id}


GET /V1/orders/{id}/comments

Summary: sales Order Management V1Get Comments List Get

Lists comments for a specified order.


POST /V1/orders/{id}/comments

Summary: sales Order Management V1Add Comment Post

Adds a comment to a specified order.


PARAMETERS /V1/orders/{id}/comments


GET /V1/orders/{id}

Summary: sales Order Repository V1Get Get

Loads a specified order.


PARAMETERS /V1/orders/{id}


POST /V1/orders/{id}/cancel

Summary: sales Order Management V1Cancel Post

Cancels a specified order.


PARAMETERS /V1/orders/{id}/cancel


POST /V1/orders/{id}/emails

Summary: sales Order Management V1Notify Post

Emails a user a specified order.


PARAMETERS /V1/orders/{id}/emails


POST /V1/orders/{id}/hold

Summary: sales Order Management V1Hold Post

Holds a specified order.


PARAMETERS /V1/orders/{id}/hold


GET /V1/orders/{id}/statuses

Summary: sales Order Management V1Get Status Get

Gets the status for a specified order.


PARAMETERS /V1/orders/{id}/statuses


POST /V1/orders/{id}/unhold

Summary: sales Order Management V1Un Hold Post

Releases a specified order from hold status.


PARAMETERS /V1/orders/{id}/unhold


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.


POST /V1/orders/

Summary: sales Order Repository V1Save Post

Performs persist operations for a specified order.


PUT /V1/orders/create

Summary: sales Order Repository V1Save Put

Performs persist operations for a specified order.


PUT /V1/orders/{parent_id}

Summary: sales Order Address Repository V1Save Put

Performs persist operations for a specified order address.


PARAMETERS /V1/orders/{parent_id}


POST /V1/products/attribute-sets/groups

Summary: catalog Product Attribute Group Repository V1Save Post

Save attribute group


GET /V1/products/attribute-sets/groups/list

Summary: catalog Product Attribute Group Repository V1Get List Get

Retrieve list of attribute groups


DELETE /V1/products/attribute-sets/groups/{groupId}

Summary: catalog Product Attribute Group Repository V1Delete By Id Delete

Remove attribute group by id


PARAMETERS /V1/products/attribute-sets/groups/{groupId}


GET /V1/products/attribute-sets/{attributeSetId}/attributes

Summary: catalog Product Attribute Management V1Get Attributes Get

Retrieve related attributes based on given attribute set ID


PARAMETERS /V1/products/attribute-sets/{attributeSetId}/attributes


DELETE /V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}

Summary: catalog Product Attribute Management V1Unassign Delete

Remove attribute from attribute set


PARAMETERS /V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}


GET /V1/products/attribute-sets/{attributeSetId}

Summary: catalog Attribute Set Repository V1Get Get

Retrieve attribute set information based on given ID


PUT /V1/products/attribute-sets/{attributeSetId}

Summary: catalog Attribute Set Repository V1Save Put

Save attribute set data


DELETE /V1/products/attribute-sets/{attributeSetId}

Summary: catalog Attribute Set Repository V1Delete By Id Delete

Remove attribute set by given ID


PARAMETERS /V1/products/attribute-sets/{attributeSetId}


PUT /V1/products/attribute-sets/{attributeSetId}/groups

Summary: catalog Product Attribute Group Repository V1Save Put

Save attribute group


PARAMETERS /V1/products/attribute-sets/{attributeSetId}/groups


POST /V1/products/attribute-sets

Summary: catalog Attribute Set Management V1Create Post

Create attribute set from data


POST /V1/products/attribute-sets/attributes

Summary: catalog Product Attribute Management V1Assign Post

Assign attribute to attribute set


GET /V1/products/attribute-sets/sets/list

Summary: catalog Attribute Set Repository V1Get List Get

Retrieve list of Attribute Sets


GET /V1/products/attributes/{attributeCode}/options

Summary: catalog Product Attribute Option Management V1Get Items Get

Retrieve list of attribute options


POST /V1/products/attributes/{attributeCode}/options

Summary: catalog Product Attribute Option Management V1Add Post

Add option to attribute


PARAMETERS /V1/products/attributes/{attributeCode}/options


DELETE /V1/products/attributes/{attributeCode}/options/{optionId}

Summary: catalog Product Attribute Option Management V1Delete Delete

Delete option from attribute


PARAMETERS /V1/products/attributes/{attributeCode}/options/{optionId}


GET /V1/products/attributes/{attributeCode}

Summary: catalog Product Attribute Repository V1Get Get

Retrieve specific attribute


PUT /V1/products/attributes/{attributeCode}

Summary: catalog Product Attribute Repository V1Save Put

Save attribute data


DELETE /V1/products/attributes/{attributeCode}

Summary: catalog Product Attribute Repository V1Delete By Id Delete

Delete Attribute by id


PARAMETERS /V1/products/attributes/{attributeCode}


GET /V1/products/attributes

Summary: catalog Product Attribute Repository V1Get List Get

Retrieve all attributes for entity type


POST /V1/products/attributes

Summary: catalog Product Attribute Repository V1Save Post

Save attribute data


GET /V1/products/attributes/types

Summary: catalog Product Attribute Types List V1Get Items Get

Retrieve list of product attribute types


DELETE /V1/products/downloadable-links/samples/{id}

Summary: downloadable Sample Repository V1Delete Delete

Delete downloadable sample


PARAMETERS /V1/products/downloadable-links/samples/{id}


DELETE /V1/products/downloadable-links/{id}

Summary: downloadable Link Repository V1Delete Delete

Delete downloadable link


PARAMETERS /V1/products/downloadable-links/{id}


GET /V1/products/links/types

Summary: catalog Product Link Type List V1Get Items Get

Retrieve information about available product link types


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


PARAMETERS /V1/products/links/{type}/attributes


POST /V1/products/options

Summary: catalog Product Custom Option Repository V1Save Post

Save Custom Option


GET /V1/products/options/types

Summary: catalog Product Custom Option Type List V1Get Items Get

Get custom option types


PUT /V1/products/options/{optionId}

Summary: catalog Product Custom Option Repository V1Save Put

Save Custom Option


PARAMETERS /V1/products/options/{optionId}


GET /V1/products/{sku}/downloadable-links/samples

Summary: downloadable Sample Repository V1Get List Get

List of samples for downloadable product


POST /V1/products/{sku}/downloadable-links/samples

Summary: downloadable Sample Repository V1Save Post

Update downloadable sample of the given product


PARAMETERS /V1/products/{sku}/downloadable-links/samples


PUT /V1/products/{sku}/downloadable-links/samples/{id}

Summary: downloadable Sample Repository V1Save Put

Update downloadable sample of the given product


PARAMETERS /V1/products/{sku}/downloadable-links/samples/{id}


Summary: downloadable Link Repository V1Get List Get

List of links with associated samples


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)



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)


PARAMETERS /V1/products/{sku}/downloadable-links/{id}


DELETE /V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}

Summary: catalog Product Tier Price Management V1Remove Delete

Remove tier price from product


PARAMETERS /V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}


POST /V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}

Summary: catalog Product Tier Price Management V1Add Post

Create tier price for product


PARAMETERS /V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}


GET /V1/products/{sku}/group-prices/{customerGroupId}/tiers

Summary: catalog Product Tier Price Management V1Get List Get

Get tier price of product


PARAMETERS /V1/products/{sku}/group-prices/{customerGroupId}/tiers


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


PARAMETERS /V1/products/{sku}/links/{type}


DELETE /V1/products/{sku}/links/{type}/{linkedProductSku}

Summary: catalog Product Link Repository V1Delete By Id Delete

catalog Product Link Repository V1Delete By Id Delete


PARAMETERS /V1/products/{sku}/links/{type}/{linkedProductSku}


Summary: catalog Product Link Repository V1Save Put

Save product link


POST /V1/products/{sku}/links

Summary: catalog Product Link Management V1Set Product Links Post

Assign a product link to another product



GET /V1/products/{sku}/media/{entryId}

Summary: catalog Product Attribute Media Gallery Management V1Get Get

Return information about gallery entry


PUT /V1/products/{sku}/media/{entryId}

Summary: catalog Product Attribute Media Gallery Management V1Update Put

Update gallery entry


DELETE /V1/products/{sku}/media/{entryId}

Summary: catalog Product Attribute Media Gallery Management V1Remove Delete

Remove gallery entry


PARAMETERS /V1/products/{sku}/media/{entryId}


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


POST /V1/products/{sku}/media

Summary: catalog Product Attribute Media Gallery Management V1Create Post

Create new gallery entry


PARAMETERS /V1/products/{sku}/media


GET /V1/products/{sku}/options/{optionId}

Summary: catalog Product Custom Option Repository V1Get Get

Get custom option for a specific product


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


PARAMETERS /V1/products/{sku}/options/{optionId}


GET /V1/products/{sku}/options

Summary: catalog Product Custom Option Repository V1Get List Get

Get the list of custom options for a specific product


PARAMETERS /V1/products/{sku}/options


PUT /V1/products/{sku}/websites

Summary: catalog Product Website Link Repository V1Save Put

Assign a product to the website


POST /V1/products/{sku}/websites

Summary: catalog Product Website Link Repository V1Save Post

Assign a product to the website


PARAMETERS /V1/products/{sku}/websites


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


PARAMETERS /V1/products/{sku}/websites/{websiteId}


GET /V1/products/{sku}

Summary: catalog Product Repository V1Get Get

Get info about product by product SKU


PUT /V1/products/{sku}

Summary: catalog Product Repository V1Save Put

Create product


DELETE /V1/products/{sku}

Summary: catalog Product Repository V1Delete By Id Delete

catalog Product Repository V1Delete By Id Delete


PARAMETERS /V1/products/{sku}


GET /V1/products

Summary: catalog Product Repository V1Get List Get

Get product list


POST /V1/products

Summary: catalog Product Repository V1Save Post

Create product


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.


PARAMETERS /V1/products/media/types/{attributeSetName}


GET /V1/products/types

Summary: catalog Product Type List V1Get Product Types Get

Retrieve available product types


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


PARAMETERS /V1/products/{productSku}/stockItems/{itemId}


GET /V1/returns/{id}/comments

Summary: rma Comment Management V1Comments List Get

Comments list


POST /V1/returns/{id}/comments

Summary: rma Comment Management V1Add Comment Post

Add comment


PARAMETERS /V1/returns/{id}/comments


GET /V1/returns/{id}/tracking-numbers

Summary: rma Track Management V1Get Tracks Get

Get track list


POST /V1/returns/{id}/tracking-numbers

Summary: rma Track Management V1Add Track Post

Add track


PARAMETERS /V1/returns/{id}/tracking-numbers


DELETE /V1/returns/{id}/tracking-numbers/{trackId}

Summary: rma Track Management V1Remove Track By Id Delete

Remove track by id


PARAMETERS /V1/returns/{id}/tracking-numbers/{trackId}


GET /V1/returns/{id}

Summary: rma Rma Repository V1Get Get

Return data object for specified RMA id


PUT /V1/returns/{id}

Summary: rma Rma Management V1Save Rma Put

Save RMA


DELETE /V1/returns/{id}

Summary: rma Rma Repository V1Delete Delete

Delete RMA


PARAMETERS /V1/returns/{id}


GET /V1/returns/{id}/labels

Summary: rma Track Management V1Get Shipping Label Pdf Get

Get shipping label int the PDF format


PARAMETERS /V1/returns/{id}/labels


GET /V1/returns

Summary: rma Rma Management V1Search Get

Return list of rma data objects based on search criteria


POST /V1/returns

Summary: rma Rma Management V1Save Rma Post

Save RMA


GET /V1/returnsAttributeMetadata

Summary: rma Rma Attributes Management V1Get All Attributes Metadata Get

Get all attribute metadata.


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


GET /V1/returnsAttributeMetadata/form/{formCode}

Summary: rma Rma Attributes Management V1Get Attributes Get

Retrieve all attributes filtered by form code


PARAMETERS /V1/returnsAttributeMetadata/form/{formCode}


GET /V1/returnsAttributeMetadata/{attributeCode}

Summary: rma Rma Attributes Management V1Get Attribute Metadata Get

Retrieve attribute metadata.


PARAMETERS /V1/returnsAttributeMetadata/{attributeCode}


GET /V1/salesRules/{ruleId}

Summary: sales Rule Rule Repository V1Get By Id Get

Get rule by ID.


PUT /V1/salesRules/{ruleId}

Summary: sales Rule Rule Repository V1Save Put

Save sales rule.


DELETE /V1/salesRules/{ruleId}

Summary: sales Rule Rule Repository V1Delete By Id Delete

Delete rule by ID.


PARAMETERS /V1/salesRules/{ruleId}


POST /V1/salesRules

Summary: sales Rule Rule Repository V1Save Post

Save sales rule.


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.


POST /V1/shipment/track

Summary: sales Shipment Track Repository V1Save Post

Performs persist operations for a specified shipment track.


DELETE /V1/shipment/track/{id}

Summary: sales Shipment Track Repository V1Delete By Id Delete

Deletes a specified shipment track by ID.


PARAMETERS /V1/shipment/track/{id}


GET /V1/shipment/{id}/comments

Summary: sales Shipment Management V1Get Comments List Get

Lists comments for a specified shipment.


POST /V1/shipment/{id}/comments

Summary: sales Shipment Comment Repository V1Save Post

Performs persist operations for a specified shipment comment.


PARAMETERS /V1/shipment/{id}/comments


GET /V1/shipment/{id}

Summary: sales Shipment Repository V1Get Get

Loads a specified shipment.


PARAMETERS /V1/shipment/{id}


POST /V1/shipment/{id}/emails

Summary: sales Shipment Management V1Notify Post

Emails user a specified shipment.


PARAMETERS /V1/shipment/{id}/emails


GET /V1/shipment/{id}/label

Summary: sales Shipment Management V1Get Label Get

Gets a specified shipment label.


PARAMETERS /V1/shipment/{id}/label


POST /V1/shipment/

Summary: sales Shipment Repository V1Save Post

Performs persist operations for a specified shipment.


GET /V1/stockItems/lowStock/

Summary: catalog Inventory Stock Registry V1Get Low Stock Items Get

Retrieves a list of SKU’s with low inventory qty


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


PARAMETERS /V1/stockItems/{productSku}


GET /V1/store/storeConfigs

Summary: store Store Config Manager V1Get Store Configs Get

store Store Config Manager V1Get Store Configs Get


GET /V1/store/storeGroups

Summary: store Group Repository V1Get List Get

Retrieve list of all groups


GET /V1/store/storeViews

Summary: store Store Repository V1Get List Get

Retrieve list of all stores


GET /V1/store/websites

Summary: store Website Repository V1Get List Get

Retrieve list of all websites


GET /V1/taxClasses/{taxClassId}

Summary: tax Tax Class Repository V1Get Get

Get a tax class with the given tax class id.


DELETE /V1/taxClasses/{taxClassId}

Summary: tax Tax Class Repository V1Delete By Id Delete

Delete a tax class with the given tax class id.


PARAMETERS /V1/taxClasses/{taxClassId}


POST /V1/taxClasses

Summary: tax Tax Class Repository V1Save Post

Create a Tax Class


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.


PUT /V1/taxClasses/{classId}

Summary: tax Tax Class Repository V1Save Put

Create a Tax Class


PARAMETERS /V1/taxClasses/{classId}


GET /V1/taxRates/{rateId}

Summary: tax Tax Rate Repository V1Get Get

Get tax rate


DELETE /V1/taxRates/{rateId}

Summary: tax Tax Rate Repository V1Delete By Id Delete

Delete tax rate


PARAMETERS /V1/taxRates/{rateId}


PUT /V1/taxRates

Summary: tax Tax Rate Repository V1Save Put

Create or update tax rate


POST /V1/taxRates

Summary: tax Tax Rate Repository V1Save Post

Create or update tax rate


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.


GET /V1/taxRules/{ruleId}

Summary: tax Tax Rule Repository V1Get Get

Get TaxRule


DELETE /V1/taxRules/{ruleId}

Summary: tax Tax Rule Repository V1Delete By Id Delete

Delete TaxRule


PARAMETERS /V1/taxRules/{ruleId}


PUT /V1/taxRules

Summary: tax Tax Rule Repository V1Save Put

Save TaxRule


POST /V1/taxRules

Summary: tax Tax Rule Repository V1Save Post

Save TaxRule


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.


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.


GET /V1/transactions/{id}

Summary: sales Transaction Repository V1Get Get

Loads a specified transaction.


PARAMETERS /V1/transactions/{id}


DELETE /V1/addresses/{addressId}

Summary: customer Address Repository V1Delete By Id Delete

Delete customer address by ID.


PARAMETERS /V1/addresses/{addressId}


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.


POST /V1/giftregistry/mine/estimate-shipping-methods

Summary: gift Registry Shipping Method Management V1Estimate By Registry Id Post

Estimate shipping


POST /V1/guest-giftregistry/{cartId}/estimate-shipping-methods

Summary: gift Registry Guest Cart Shipping Method Management V1Estimate By Registry Id Post

Estimate shipping


PARAMETERS /V1/guest-giftregistry/{cartId}/estimate-shipping-methods


POST /V1/invoice/{invoiceId}/refund

Summary: sales Refund Invoice V1Execute Post

Create refund for invoice


PARAMETERS /V1/invoice/{invoiceId}/refund


GET /V1/modules

Summary: backend Module Service V1Get Modules Get

Returns an array of enabled modules


POST /V1/reward/mine/use-reward

Summary: reward Reward Management V1Set Post

Set reward points to quote


GET /V1/search

Summary: search V1Search Get

Make Full Text Search and return found Documents


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.


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


PARAMETERS /V1/stockStatuses/{productSku}


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


PARAMETERS /V1/worldpay-guest-carts/{cartId}/payment-information