3d Cart Web API/v1-Admin Permissions

Get all Admin Permissions Get a Permission

3d Cart Web API/v1-Admins-{id}

Get an Admin User Get the LoginToken from a specific Admin User

3d Cart Web API/v1-Admins

Get all Admin Users

3d Cart Web API/v1-Cart-{orderkey}-Item

Adds a new item to a cart Updates a specific item from a specific Cart

3d Cart Web API/v1-Cart-{orderkey}

Get a specific cart

3d Cart Web API/v1-Cart

Adds a new cart to the system

3d Cart Web API/v1-Categories-{categoryid}-Options

Get the options from a specific Category Updates specific options from a specific Category

3d Cart Web API/v1-Categories-{categoryid}

This method is used to update a single category record in the database. The {categoryid} parameter specifies which category to update.Get all products from a specific category

3d Cart Web API/v1-Categories

Get all Categories Get a Category

3d Cart Web API/v1-CRM-{crmid}/message

Get all the messages from a specific CRM Get a specific Message

3d Cart Web API/v1-CRM-{id}

Get a specific CRM Adds a new CRM Message to the system

3d Cart Web API/v1-CRM-department

Get all CRM Departments This method is used to update a single CRM Department record in the database. The {id} parameter specifies which CRM Department record to update.

3d Cart Web API/v1-CRM-savedreply

Get all CRMs Get a specific CRM Saved Reply

3d Cart Web API/v1-CRM-status

Get all CRM Status This method is used to update a single CRM Status record in the database. The {id} parameter specifies which CRM Status record to update.

3d Cart Web API/v1-CRM

3d Cart Web API/v1-Customer Groups-{id}

Get a CustomerGroup Get Customers from a Customer Group

3d Cart Web API/v1-Customer Groups

Get all CustomerGroups This method is used to update a single customer group in the database. The {id} parameter specifies which customer group to update.

3d Cart Web API/v1-Customers

Get all Customers This method is used to update a single customer record in the database. The {id} parameter specifies which customer record to update.Get a Customer

3d Cart Web API/v1-Distributors-{distributorid}

This method is used to update a single distributor record in the database. The {distributorid} parameter specifies which distributor to update.Get all products from a specific distributor

3d Cart Web API/v1-Distributors

Get all Distributors Get a Distributor

3d Cart Web API/v1-Frontend Scripts

Get all Frontend Scripts This method is used to update a single frontend script record in the database. The {frontendscriptid} parameter specifies which frontendscript record to update.Get a Frontend Script

3d Cart Web API/v1-Gift Registries-{giftregistryid}

Get a specific GiftRegistry Gets the items from a specific Gift Registry

3d Cart Web API/v1-Gift Registries

Get all GiftRegistries

3d Cart Web API/v1-Manufacturers-{manufacturerid}

This method is used to update a single manufacturer record in the database. The {manufacturerid} parameter specifies which manufacturer record to update.Get all products from a specific manufacturer

3d Cart Web API/v1-Manufacturers

Get all Manufacturers Get a Manufacturer

3d Cart Web API/v1-Orders-{orderid}-Items

Gets the items from a specific Order Updates a specific item from a specific Product

3d Cart Web API/v1-Orders-{orderid}-Questions

Gets the questions from a specific Order Updates a specific question from a specific Product

3d Cart Web API/v1-Orders-{orderid}-Shipments

Gets the shipments from a specific Order Updates a specific shipment from a specific Order

3d Cart Web API/v1-Orders-{orderid}-Transactions

Gets the transactions from a specific Order Updates a specific transaction from a specific Product

3d Cart Web API/v1-Orders-{orderid}

Get a specific order

3d Cart Web API/v1-Orders

3d Cart Web API/v1-Order Status

Get all OrderStatus Get an OrderStatus

3d Cart Web API/v1-Payment Tokens

Get all Payment Tokens Get a Payment Token This method is used to update a single paymenttoken record in the database. The {paymenttokenid} parameter specifies which paymenttoken record to update.

3d Cart Web API/v1-Products-{catalogid}-Advanced Options

Get the advanced options from a specific Product Updates specific advanced options from a specific Product

3d Cart Web API/v1-Products-{catalogid}-Discount

Get the discounts from a specific Product Updates a specific discount from a specific Product

3d Cart Web API/v1-Products-{catalogid}-E Products

Get the EProducts from a specific Product Updates a specific eproduct from a specific Product

3d Cart Web API/v1-Products-{catalogid}-Features

Get the features from a specific Product Updates a specific feature from a specific Product

3d Cart Web API/v1-Products-{catalogid}-Images

Get the images from a specific Product Updates a specific image from a specific Product

3d Cart Web API/v1-Products-{catalogid}-Options

Get the options from a specific Product Updates specific options from a specific Product

3d Cart Web API/v1-Products-{catalogid}-Related

Get the related products from a specific Product Updates a specific related product from a specific Product

3d Cart Web API/v1-Products-{catalogid}-Serials

Get the serials from a specific Product Updates a specific serial from a specific Product

3d Cart Web API/v1-Products-{catalogid}-Up Selling

Get the upselling products from a specific Product Updates a specific Upselling Item from a specific Product

3d Cart Web API/v1-Products-{catalogid}

Get a product Get the categories from a specific Product Get the distributors from a specific Product Get all products (SKUInfo section only)

3d Cart Web API/v1-Products

Get all products Get all products (SKUInfo section only)

3d Cart Web API/v1-Promotions

Get all Promotions Get a Promotion This method is used to update a single promotion record in the database. The {promotionid} parameter specifies which promotion to update.

3d Cart Web API/v1-RMA-{rmaid}

Get a specific RMA Gets the items from a specific RMA

3d Cart Web API/v1-RMA

3d Cart Web API/v1-Webhooks

Get all Webhooks Get a Webhook Get all Events

3d Cart Web API/v1

Get the Store Settings

API REST Documentation

Get product SKUs matching to parameters specified in request Delete product SKU

Search Affiliates Get Affiliate

additionalfields-{Field Code}

Extract information about a specific additional field you set up for your account Extract additional field texts and translations.

additionalfields

Extract information about additional fields you set up for your account

Get crossSell campaigns by filter /crosssells/settings/

Working example: Retrieve cross-sell campaign texts Working example: Retrieve cross-sell campaign texts

customers-{C Reference}

Working example of how to retreive a customer Working example: SSO by customer reference Working example: SSO in cart

Working example: Retrieve Single Sign On customer info by SSOToken

invoices/{Order Reference}

Extract invoices for specific orders. The output contains the binary code for invoices in the PDF file format, Base64 encoded (Base64 is used to represent binary data in the ASCII string format).Extract invoices for specific refunds. The output contains the binary code for invoices in the PDF file format, Base64 encoded (Base64 is used to represent binary data in the ASCII string format).

Working example: Retrieve session for dynamic products Retrieve installment settings used to place orders with installments Working example: Retrieve shipping price Get order reference by invoice id Extract cost information for a product/subscription plan, based on a specific list of options.

Search orders by ApproveStatus, Newer, Status, StartDate, EndDate, ExternalRefNo having Page and Limit Working example: Retrieve an order with dynamic products Working example: Issue a partial refund

Working example: Retrieve the list of banks that support iDEAL Working example: Retrieve PayPal Express redirect URL Validate order references in order to be used for a new order using previous order as payment reference

/payouts/Retrieve account balance

Working example: Retrieve price option groups Working example: Retrieve a price options group

Retrieve product groups Retrieve a product group

products-{Product Code}-pricingconfigurations-{Code}

Working example: Retrieve a pricing configuration Working example: Retrieve SKU code by details

products-{Product Code}-pricingconfigurations

Working example: Retrieve pricing configurations Working example: Retrieve SKU details

products-{Product Code}-promotions

Working example: Retrieve all promotions set for a product Working example: Retrieve a product's promotion

products-{Product Code}

Retrieve product info by code Get crossSell campaigns by filter Working example: Retrieve a price options group Assign a product to a product group Set product upgrade schema

Retrieve subscription plan and product info

promotions-{Promotion Code}

Working example: Retrieve a promotion Working example: Update promotion coupon Working example: Add products to a promotion Working example: Add promotion sources Working example: Add promotion translations

Working example: Retrieve all active promotions

Get all shipping fees Get shipping fee

subscriptions-{Subscription Reference}-additionalinformation

Retrieve information attached to a subscription Retrieve information attached to a subscription by key

subscriptions-{Subscription Reference}-history

Retrieve the history of a subscription Retrieve a subscription's purchase, renewal or upgrade details

subscriptions-{Subscription Reference}-renewal

Retrieve renewal links and recurring billing status Set a custom grace period Enable renewal notification Retrieve a subscription's next renewal price Convert a trial Retrieve a subscription's pause information Trigger immediate billing for a pay per usage subscription

subscriptions-{Subscription Reference}-upgrade

Retrieve upgrade options for a subscription Retrieve product upgrade price for a subscription

subscriptions-{Subscription Reference}-usages

Filter usages for a subscription Update a specific usage entry

subscriptions-{Subscription Reference}

Retrieve a subscription Retrieve a subscription’s customer Retrieve a subscription's end user Retrieve the payment info for a subscription SSO by subscription reference

Search Subscriptions

proposals-{proposal Id}

Retrieve a proposal Execute an action on the proposal

Search proposals

Search shipping methods Search Leads

Post Webhook Create Get Webhook List Get Webhook Count Get Webhook Events Delete Webhook Delete Put Webhook Update Post Cart Create Get Cart Validate Get Cart List Get Cart Bridge Delete Cart Delete Get Cart Disconnect Get Cart Methods Get Cart Config Put Cart Config Update Get Cart Coupon Count Get Cart Coupon List Get Cart Giftcard Count Get Cart Giftcard List Post Cart Giftcard Add Post Cart Coupon Add Post Cart Coupon Condition Add Delete Cart Coupon Delete Get Cart Script List Post Cart Script Add Delete Cart Script Delete Get Cart Info Post Cart Clear Cache Get Cart Plugin List Get Cart Shipping Zones List Get Account Cart List Post Account Cart Add Put Account Config Update Get Account Failed Webhooks Get Account Supported Platforms Get Bridge Download File Post Bridge Update Post Bridge Delete Get Product List Get Product Count Get Product Info Get Product Find Get Product Fields Post Product Add Put Product Update Delete Product Delete Post Product Price Add Put Product Price Update Delete Product Price Delete Post Product Image Add Put Product Image Update Delete Product Image Delete Get Category List Get Category Count Get Category Info Get Category Find Post Category Add Put Category Update Delete Category Delete Post Category Assign Post Category Unassign Post Category Image Add Delete Category Image Delete Get Order Count Get Order List Get Order Info Get Order Find Post Order Add Put Order Update Get Order Status List Get Order Financial Status List Get Order Abandoned List Get Order Shipment List Post Order Shipment Add Put Order Shipment Update Post Order Shipment Tracking Add Post Order Refund Add Get Basket Live Shipping Service List Get Basket Info Post Basket Live Shipping Service Create Delete Basket Live Shipping Service Delete Get Customer List Get Customer Count Get Customer Info Get Customer Find Post Customer Add Get Attribute List Get Attribute Info Get Attribute Count Get Attribute Type List Delete Attribute Delete Post Attribute Add Post Attribute Assign Group Post Attribute Assign Set Post Attribute Unassign Group Post Attribute Unassign Set Get Attribute Group List Get Attribute Attributeset List Get Product Attribute List Post Product Attribute Value Set Post Product Option Add Get Product Option List Post Product Option Assign Post Product Option Value Add Post Product Option Value Assign Put Product Option Value Update Get Product Review List Post Product Variant Add Get Product Child Item Info Get Product Child Item List Get Product Child Item Find Get Product Variant List Get Product Variant Info Get Product Variant Count Put Product Variant Update Delete Product Variant Delete Post Product Variant Price Add Put Product Variant Price Update Delete Product Variant Price Delete Post Product Tax Add Post Product Manufacturer Add Get Product Brand List Post Product Currency Add Get Product Currency List Post Product Store Assign Get Tax Class Info Post Basket Item Add Get Subscriber List Get Bridge Download

Adyen Checkout API

Starts a transaction.Submits details for a payment.Verifies payment result.

Creates a payment link.Returns available payment methods.Creates a payment session.

Adyen Checkout Utility Service

Create originKey values for one or more merchant domains.

Adyen MarketPay Account API

Request to perform verification for an account holder.Close an existing account under an account holder.Close an existing account holder.Create a new account under an existing account holder.Create a new account holder.Delete bank accounts of an existing account holder.Delete payout methods of an existing account holder.Delete shareholders of an existing account holder.Retrieve the details of an account holder.Retrieve the uploaded documents of an existing account holder.Suspend an existing account holder.Reinstate a disabled account holder.Update an existing account under an account holder.Update an existing account holder.Update the state of an existing account holder.Upload a document for an existing account holder.

Adyen MarketPay Account Service

Close an existing account under an account holder.Close an existing account holder.Create a new account under an existing account holder.Create a new account holder.Delete bank accounts of an existing account holder.Delete shareholders of an existing account holder.Retrieve the details of an account holder.Retrieve the uploaded documents of an existing account holder.Suspend an existing account holder.Reinstate a disabled account holder.Update an existing account under an account holder.Update an existing account holder.Update the state of an existing account holder.Upload a document for an existing account holder.

Adyen MarketPay Fund API

Retrieve the balance(s) of an account holder.Retrieve a list of transactions.Disburse a specified amount from an account to the account holder.Make a refund of the existing transfer funds transfer.Refund all transactions of an account since the most recent payout.Designate an account to be the beneficiary of a separate account and transfer the benefactor's current balance to the beneficiary.Transfer funds from one platform account to another.

Adyen MarketPay Fund Service

Retrieve the balance(s) of an account holder.Retrieve a list of transactions.Disburse a specified amount from an account to the account holder.Refund all transactions of an account since the most recent payout.Designate an account to be the beneficiary of a separate account and transfer the benefactor's current balance to the beneficiary.Transfer funds from one platform account to another.

Adyen MarketPay Notification Configuration API

Configure a new subscription to notifications.Delete an existing notification subscription configuration.Retrieve an existing notification subscription configuration.Retrieve a list of existing notification subscription configurations.Test an existing notification configuration.Update an existing notification subscription configuration.

Adyen Payment API

Increases or decreases the authorised amount.Creates a payment authorisation.Completes a 3D Secure payment authorisation.Completes a 3D Secure 2 payment authorisation.Cancels an authorised payment.Cancels or refunds a payment.Captures an authorised payment.Return the authentication result after doing a 3D Secure authentication only.Refunds a captured payment.Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.Cancels a payment using your custom reference.Cancels a POS refund request before it has been completed.

Adyen Payout API

Confirms a payout.Cancels a payout.Pay out directly.Stores payout details.Stores details and submits a payout.Submits a payout.

Adyen Recurring API

Disables stored payment details.Retrieves stored payment details for a shopper.Schedules running of the Account Updater.

Adyen Recurring Service

Disables stored payment details.Retrieves stored payment details for a shopper.

rest/v1-assets-paint-reference-files/no-locale

asset reference file (2.1 only)download asset reference file (2.1 only)

rest/v1-assets-paint-variation-files/ecommerce/no-locale

asset variation file (2.1 only)download asset variation file (2.1 only)

rest/v1-assets-paint

asset (2.1 only)

assets (2.1 only)

rest/v1-asset-categories

asset categories (2.1 only)asset category (2.1 only)asset category (2.1 only)

rest/v1-asset-tags

asset tags (2.1 only)asset tag (2.1 only)

rest/v1-association-types

association types (2.x only)association type (2.x only)

rest/v1-attributes-main color/options

attribute options attribute option

rest/v1-attributes

attributes attribute

rest/v1-attribute-groups

attribute groups (2.x only)attribute group (2.x only)

rest/v1-categories

categories category category

rest/v1-channels

channels channel channel (2.x only)

rest/v1-currencies

currencies (2.x only)currency (2.x only)

rest/v1-families-clothing/variants

family variants (2.x only)family variant (2.x only)

rest/v1-families

families family

rest/v1-locales

rest/v1-measure-families

measure families (2.x only)measure family (2.x only)

rest/v1-media-files

rest/v1-products-AKNTS BPS

draft (2.x and EE only)proposal (2.x and EE only)

rest/v1-products

products product product

rest/v1-product-models-amor

product model (2.x only)draft (2.3 and EE only)proposal (2.3 and EE only)

rest/v1-product-models

product models (2.x only)

rest/v1-published-products

published products (2.x and EE only)published product (2.x and EE only)

Authentification by refresh token

Digital River Shopper

Get Oauth20 Authorize Post Oauth20 Token

v1-shoppers-me-addresses

Get Shoppers Me Addresses Get Shoppers Me Addresses

v1-shoppers-me-carts/active-line-items

Delete Shoppers Me Carts Active Line Items Delete Shoppers Me Carts Active Line Items

v1-shoppers-me-carts/active-shipping-options

Get Shoppers Me Carts Active Shipping Options Get Shoppers Me Carts Active Shipping Options

v1-shoppers-me-carts/active

Get Shoppers Me Carts Active Post Shoppers Me Carts Active Apply Shipping Option Post Shoppers Me Carts Active Apply Shopper Get Shoppers Me Carts Active Billing Address Get Shoppers Me Carts Active Point Of Promotions Offers Get Shoppers Me Carts Active Shipping Address Post Shoppers Me Carts Active Submit Cart Get Shoppers Me Carts Active Web Checkout

v1-shoppers-me-categories-{id}

Get Shoppers Me Categories Get Shoppers Me Categories Products

v1-shoppers-me-categories

Get Shoppers Me Categories

v1-shoppers-me-orders-{id}-line-items

Get Shoppers Me Orders Line Items Get Shoppers Me Orders Line Items Lineitemid

v1-shoppers-me-orders-{id}

Get Shoppers Me Orders Get Shoppers Me Orders Billing Address Get Shoppers Me Orders Shipping Address

v1-shoppers-me-orders

Get Shoppers Me Orders

v1-shoppers-me-payment-options

Get Shoppers Me Payment Options Get Shoppers Me Payment Options

v1-shoppers-me-point-of-promotions/{id}/offers-{offer Id}-product-offers

Get Shoppers Me Point Of Promotions Offers Offerid Product Offers Get Shoppers Me Point Of Promotions Offers Offerid Product Offers Productid

v1-shoppers-me-point-of-promotions/{id}/offers-{offer Id}

Get Shoppers Me Point Of Promotions Offers Offerid

v1-shoppers-me-point-of-promotions/{id}/offers

Get Shoppers Me Point Of Promotions Offers

v1-shoppers-me-products-{id}

Get Shoppers Me Products Get Shoppers Me Products Point Of Promotions Popid Offers Post Shoppers Me Products Purchase Get Shoppers Me Products Variations

v1-shoppers-me-products

Get Shoppers Me Products

v1-shoppers-me-purchase-plan

Post Shoppers Me Purchase Plan Authorize Get Shoppers Me Purchase Plan Search

Get Shoppers Me Get Shoppers Me Account Get Shoppers Me Product Search

Post Shoppers Get Shoppers Token

Get Shoppers Api

Get Item Get Item Get Item By Legacy Get Item Get Items By Item Group Get Item Item

merchandised product

Get Merchandised Product Get Merchandised Product Get Also Bought Products Get Merchandised Product Get Also Viewed Products

category tree/{category tree id}

Get Category Tree Category Tree Get Category Tree Category Tree Get Category Subtree Get Category Tree Category Tree Get Category Suggestions Get Category Tree Category Tree Get Item Aspects For Category

order-{order Id}-shipping fulfillment

Get Order Order Shipping Fulfillment Get Order Order Shipping Fulfillment Fulfillment

order-{order Id}

Get Order Order

Get Item Summary Search Get Item Description Get Get Default Category Tree

Get all product classes Get product class details Delete custom product class

orders-SET-ORDER-ID-items/SET-ORDER-ITEM-ID/options/SET-OPTION-NAME

Upload a new product option file for a purchased item Delete a product option file

orders-SET-ORDER-ID

Get order details

Search orders by keywords Get deleted orders

Search customers Get customer details Get deleted customers

categories-SET-CATEGORY-ID

Get category details Upload / add category icon

Get all categories

Get a store profile Add / upload store logo Add / upload invoice logo

products-SET-PRODUCT-ID-gallery

Upload additional (gallery) product image Delete one additional (gallery) product image

products-SET-PRODUCT-ID-combinations-SET-COMBINATION-ID

Get a specific combination Add / upload a product combination image

products-SET-PRODUCT-ID-combinations

Get all combinations for a product

products-SET-PRODUCT-ID-files

Add product file (e-goods)Delete product file

products-SET-PRODUCT-ID

Get product details Add / Update product image

Show "out of stock" products Update product options Get deleted products

discount coupons

Get all discount coupons Get a discount coupon Get deleted coupons

Get stats about product/order/profile updates

Delete Products Put Products Enable

products-:product id-custom fields

Get Products Custom Fields Put Products Custom Fields Name

products-:product id-offer codes

Get Products Offer Codes Get Products Offer Codes

products-:product id-variant categories-:variant category id/variants

Post Products Variant Categories Variant Category Variants Delete Products Variant Categories Variant Category Variants

products-:product id-variant categories

Get Products Variant Categories Delete Products Variant Categories

countries-{country code}

Get Countries Country Code Regions Get Countries Country Code Regions Region Code

Get Countries Country Code

customer categories

Delete Customer Categories Delete Customer Categories Customers

Get Customers Email Email Delete Customers

Get Orders Status Status Get Orders Get Orders History

products-category

Get Products Category Category Get Products Category Category Count

products-status

Get Products Status Status Get Products Status Status Count

products-{id}-images

Get Products Images Count Delete Products Images Image

products-{id}-options-{option id}-values

Get Products Options Option Values Count Delete Products Options Option Values Value

products-{id}-options-{option id}

Get Products Options Option Values

products-{id}-options

Get Products Options Count Delete Products Options Option

products-{id}-variants

Get Products Variants Count Get Products Variants Variant

Get Products Fields Get Products Fields Count Get Products Images Get Products Options Get Products Variants

Get Products After Get Products Count Get Products Search Get Products Sku Sku Delete Products

Get Store Info Get Store Languages

Get Apps Get Categories Delete Categories Get Checkout Custom Fields Delete Checkout Custom Fields Get Countries Get Customer Categories Get Customers Get Fields Get Hooks Delete Hooks Post Jsapps Delete Jsapps Code Get Orders Get Payment Methods Get Payment Methods Get Products Get Promotions Delete Promotions Post Settings Get Settings Name

Retrieve the product for the specified ASIN and domain.Returns Amazon category information from Keepa API.

Logicbroker Commerce

api/v1-Acknowledgements-{Logicbroker Key}-Status

Retrieve acknowledgement status Update acknowledgement status

api/v1-Acknowledgements-{Logicbroker Key}

Get acknowledgement details Retrieve EDI

api/v1-Acknowledgements

Search acknowledgements Create acknowledgement(s) based on custom XML.Request an acknowledgement from a trading partner Export to CSV/XLSX Import from flat file.

api/v1-Activity Events

Get events for given fitlers Gets the event with the specified id.Gets a list of all possible event types.

api/v1-Attachments

Get a list of all attachments matching a given filter.Retrieve a file from Logicbroker storage.

api/v1-Inventory-{partner Id}

Download inventory as CSV.Match items with CSV.Resend all inventory items.Get a single item by SKU

api/v1-Inventory

Import inventory from CSV.Get the availability of an item across all suppliers.

api/v1-Invoices-{Logicbroker Key}-Status

Return the current status code of an invoice.Updates an invoice to the specified status.

api/v1-Invoices-{Logicbroker Key}

Returns the invoice with the specified key.Retrieve related events Retrieve EDI

api/v1-Invoices

Get invoices based on provided filters Create invoice(s) based on custom XML.Import from flat file.Export to CSV/XLSX

api/v1-Orders-{Logicbroker Key}-Status

Retrieve order status Update order status

api/v1-Orders-{Logicbroker Key}

Retrieve an order Retrieve a list of invoices for an order Retrieve a list of shipments for an order Retrieve related events Retrieve a list of returns for an order Retrieve EDI Get pick list for one order Get shipping/tracking label options.Generate a tracking label for a given package

Search orders Create order(s) based on custom XML.Import from flat file.Export to CSV/XLSX Get pick lists for multiple orders

api/v1-Product/{partner Id}-{feed Id}-Items

Get items in the product feed.Get product feed item.

api/v1-Product/{partner Id}-{feed Id}

Get product feed status.

api/v1-Product/{partner Id}

Import product from CSV.

api/v1-Returns-{Logicbroker Key}-Status

Retrieve return status Update return status

api/v1-Returns-{Logicbroker Key}

Get return details Retrieve EDI

Search returns Create return(s) based on custom XML.Request a return Export to CSV/XLSX Import from flat file.

api/v1-Shipments-{Logicbroker Key}-status

Get shipment status Update shipment status

api/v1-Shipments-{Logicbroker Key}

Get shipment details Retrieve related events Retrieve EDI Get packing slips for one shipment Get shipping labels for one shipment.

api/v1-Shipments

Get shipments for given filters Create shipment(s) based on custom XML.Import from flat file.Export to CSV/XLSX Get packing slips for multiple shipments Get shipping labels for multiple shipments Gets a new SSCC18 container code.

api/v1-Statuses

Get configured document statuses for each document Get configured document statuses for each document

api/v1-Webhooks-{Webhook Id}

Get webhook details Test a webhook endpoint.

api/v1-Webhooks

Get list of webhooks

Execute custom handler.Retrieve a list of trading partners.

admin-script tags

Get a single script tag update a script tag Get a count of all script tags

admin-comments-2941387470

Mark a comment as Spam Remove a comment Approve a comment Mark a comment as not spam restore a comment

Update a comment Get a single comment Get a count of all comments

admin-smart collections

Get a single collection Get a count of all collections Delete a single collection

admin-products-7990943555-metafields

Get a count of all metafields that belong to a product Get a single product metafield using the metafield's nested resource path

admin-products-7990943555-variants

Get a count of variants for a product Delete a product variant

admin-products-7990943555-images

Get a single product image by id Get a count of all product images

admin-products-7990943555

Get all product images Get all variants for a product Get all metafields that belong to a product Get all the events from a particular product

Update a product and one of its variants Count all products Get a single product

admin-orders-4554953422-refunds

Calculate a refund for a line item and shipping Get a representation of a single refund

admin-orders-4554953422-transactions

Get a count of transactions for an order Get a specific transaction

admin-orders-4554953422

Canceling an Order Close a processed order Get all the events from a particular order Get all refunds from a specific order Re-opening a closed Order Get all transactions for an order

admin-orders-4602125518

Get all Order Risks for an Order Get a single Order Risk

admin-orders-4495703502-fulfillments/3763917198

Delete a fulfillment event.Create a fulfillment event.

admin-orders-4495703502

Get a list of all fulfillments for an order.

admin-orders-4528049998/fulfillments-3770145678

Cancel a fulfillment.Complete a fulfillment.Fetch a fulfillment event.Transition a fulfillment from pending to open.Get a list of all fulfillment events for a fulfillment

admin-orders-4528049998/fulfillments

Get the Representation of a specific fulfillment.Count all the total number of fulfillments for an order.

Get a representation of a single order Count all orders

admin-collects.json

List all collects Add a product to a collection

admin-blogs-62581763-articles

Get a single article by its ID and the ID of the parent blog Get a count of all articles from a certain blog Delete an article of a blog tags of articles

admin-blogs-62581763

Get a list of all articles from a certain blog

Update a blog Get a single blog by its ID Get a count of all blogs

admin-gift cards

Disable a gift card Show a specific gift card's details Retrieve a count of all gift cards Update the expiry date of a gift card Get all gift cards that matches the query

Update a Webhook Get a count of all webhooks for your shop.Get a single webhook by its id.

admin-metafields

Get a single store metafield by ID Get a count of all metafields for a store

Count all pages for a shop update a page Get a single page by its ID

admin-customers-3989659651-addresses

Updating a customers postal code assigning a new default address to a customer destroying multiple customer addresses Get a single customers address

admin-customers-3989659651

Get all of a customer's addresses

admin-customers

Get all customers with an address in the Brazil Add metafield to an existing customer Get a single customer by ID Get a count of all customers

admin-custom collections

Get a single custom collections Get a count of all custom collections

admin-comments.json

Create a new comment for an article Get a list of all comments

Get a list of all the tags of articles Get a list of all the authors of articles

Update an existing product variant Get a product variant by id

admin-customer saved searches

Get all customers who match the criteria Get a count of all customer saved searches Update an existing Customer Saved Search Get one customer saved search by ID

Shows the same fields as the list action.Count all the events

admin-countries-261414723-provinces

Get a count of all provinces get a single province

admin-countries-261414723

Get all provinces

admin-countries

update a country Show Country Get a count of all countries

Return a collect with a certain id Remove a product from a collection Get a count of all collects

admin-discounts-2951196163

Disable a discount Enable a discount

admin-discounts

Retrieve a discount

Get a list of all theme assets Get a single theme Update a theme's attributes

admin-redirects

Get a countt of all URL redirect Update a redirect Get a single URL redirect

admin-application charges

Activate a one-time charge Retrieve one-time application charge

Get a list of all custom collections Get all metafields that belong to a store Get a list of all blogs getting the shops policies Get a list of all countries List your app's fulfillment services Retrieving all one-time charges since a specified ID Get a list of all gift cards Get all collection Get a single location Get a list of all webhooks for your shop.Get all orders from a customer List carrier services Get a single fulfillment service by its ID Get a list of all pages List all discounts Get a list of all locations for a shop Update a carrier service List all abandoned checkouts Get all customer saved searches for a shop Get a list of all URL redirect Get a list of all script tags Get the configuration of the shop account Get all products Create a new charge Retrieve all customers Get all shop themes Show list of shipping zones Get a count of checkouts

Hack Authentication

v2-customers-{customer id}-cards

Post Customers Cards Delete Customers Cards

v2-customers-{customer id}

Delete Customers

v2-locations-{location id}-transactions-{transaction id}

Get Locations Transactions Post Locations Transactions Capture Post Locations Transactions Refund Post Locations Transactions Void

v2-locations-{location id}-transactions

Get Locations Transactions

v2-locations-{location id}

Get Locations Refunds Post Locations Checkouts

v2-catalog-object

Post Catalog Object Delete Catalog Object

Post Catalog Batch Delete Post Catalog Batch Retrieve Post Catalog Batch Upsert Get Catalog Info Get Catalog List Post Catalog Search Post Catalog Update Item Modifier Lists Post Catalog Update Item Taxes

v1-me-employees

Get Me Employees Get Me Employees

Get Me Roles Get Me Roles

v1-me-timecards-{timecard id}

Delete Me Timecards Get Me Timecards Events

v1-me-timecards

Get Me Timecards

Get Me Get Me Locations

v1-{location id}-bank-accounts

Get Location Bank Accounts Get Location Bank Accounts Bank Account

v1-{location id}-cash-drawer-shifts

Get Location Cash Drawer Shifts Get Location Cash Drawer Shifts

v1-{location id}-categories

Get Location Categories Delete Location Categories Category

v1-{location id}-discounts

Get Location Discounts Delete Location Discounts

v1-{location id}-fees

Get Location Fees Delete Location Fees

v1-{location id}-inventory

Get Location Inventory Post Location Inventory Variation

v1-{location id}-items-{item id}-variations

Post Location Items Variations Delete Location Items Variations

v1-{location id}-items-{item id}

Delete Location Items Delete Location Items Fees Delete Location Items Modifier Lists Modifier List

v1-{location id}-items

Get Location Items

v1-{location id}-modifier-lists-{modifier list id}-modifier-options

Post Location Modifier Lists Modifier List Modifier Options Delete Location Modifier Lists Modifier List Modifier Options Modifier Option

v1-{location id}-modifier-lists-{modifier list id}

Delete Location Modifier Lists Modifier List

v1-{location id}-modifier-lists

Get Location Modifier Lists

v1-{location id}-orders

Get Location Orders Get Location Orders

v1-{location id}-pages-{page id}

Delete Location Pages Delete Location Pages Cells

v1-{location id}-pages

Get Location Pages

v1-{location id}-payments

Get Location Payments Get Location Payments

v1-{location id}-settlements

Get Location Settlements Get Location Settlements

v1-{location id}

Get Location Refunds

Walmart Marketplace API

tokenGeneration_authentication tokenDetails_authentication

bulkUpdateInventory getFeedStatusWODetails

getAllItemsWithNextCursor getItem retireItem

v3-orders-4793302295726

getOrder ackOrder

getAllOrders getAllReleasedOrders cancelOrderLine refundOrderLine shippingOrderLine

getReturns issueRefund

v3-rules-{rule Id}/status/{rule Status}

deleteRule getSimulationResult downloadSimulationResult

getAllRules getARules createItemRule updateShippingAreasToRules inactivateRule createOverrideExceptions changeAssortmentType downloadExceptions getAllSubCategories getAllAreas

v3-settings-shipping-shipnodes

createFulfillmentCenter updateAFulfillmentCenter getCoverageForFulfillmentCenters

v3-settings-shipping

createThirdPartyFulfillmentNode getAllThirdPartyFulfillmentProviders getCarrierMethods

deleteExceptions

updateInventory updatePrice setupCAPskuAll getPromoPrice getLagtime getItemReport

3d Cart Web API/v1-Admin Permissions

Get all Admin Permissions Get a Permission

3d Cart Web API/v1-Admins-{id}

Get an Admin User Get the LoginToken from a specific Admin User

3d Cart Web API/v1-Admins

Get all Admin Users

3d Cart Web API/v1-Cart-{orderkey}-Item

Adds a new item to a cart Updates a specific item from a specific Cart

3d Cart Web API/v1-Cart-{orderkey}

Get a specific cart

3d Cart Web API/v1-Cart

Adds a new cart to the system

3d Cart Web API/v1-Categories-{categoryid}-Options

Get the options from a specific Category Updates specific options from a specific Category

3d Cart Web API/v1-Categories-{categoryid}

This method is used to update a single category record in the database. The {categoryid} parameter specifies which category to update.Get all products from a specific category

3d Cart Web API/v1-Categories

Get all Categories Get a Category

3d Cart Web API/v1-CRM-{crmid}/message

Get all the messages from a specific CRM Get a specific Message

3d Cart Web API/v1-CRM-{id}

Get a specific CRM Adds a new CRM Message to the system

3d Cart Web API/v1-CRM-department

Get all CRM Departments This method is used to update a single CRM Department record in the database. The {id} parameter specifies which CRM Department record to update.

3d Cart Web API/v1-CRM-savedreply

Get all CRMs Get a specific CRM Saved Reply

3d Cart Web API/v1-CRM-status

Get all CRM Status This method is used to update a single CRM Status record in the database. The {id} parameter specifies which CRM Status record to update.

3d Cart Web API/v1-CRM

3d Cart Web API/v1-Customer Groups-{id}

Get a CustomerGroup Get Customers from a Customer Group

3d Cart Web API/v1-Customer Groups

Get all CustomerGroups This method is used to update a single customer group in the database. The {id} parameter specifies which customer group to update.

3d Cart Web API/v1-Customers

Get all Customers This method is used to update a single customer record in the database. The {id} parameter specifies which customer record to update.Get a Customer

3d Cart Web API/v1-Distributors-{distributorid}

This method is used to update a single distributor record in the database. The {distributorid} parameter specifies which distributor to update.Get all products from a specific distributor

3d Cart Web API/v1-Distributors

Get all Distributors Get a Distributor

3d Cart Web API/v1-Frontend Scripts

Get all Frontend Scripts This method is used to update a single frontend script record in the database. The {frontendscriptid} parameter specifies which frontendscript record to update.Get a Frontend Script

3d Cart Web API/v1-Gift Registries-{giftregistryid}

Get a specific GiftRegistry Gets the items from a specific Gift Registry

3d Cart Web API/v1-Gift Registries

Get all GiftRegistries

3d Cart Web API/v1-Manufacturers-{manufacturerid}

This method is used to update a single manufacturer record in the database. The {manufacturerid} parameter specifies which manufacturer record to update.Get all products from a specific manufacturer

3d Cart Web API/v1-Manufacturers

Get all Manufacturers Get a Manufacturer

3d Cart Web API/v1-Orders-{orderid}-Items

Gets the items from a specific Order Updates a specific item from a specific Product

3d Cart Web API/v1-Orders-{orderid}-Questions

Gets the questions from a specific Order Updates a specific question from a specific Product

3d Cart Web API/v1-Orders-{orderid}-Shipments

Gets the shipments from a specific Order Updates a specific shipment from a specific Order

3d Cart Web API/v1-Orders-{orderid}-Transactions

Gets the transactions from a specific Order Updates a specific transaction from a specific Product

3d Cart Web API/v1-Orders-{orderid}

Get a specific order

3d Cart Web API/v1-Orders

3d Cart Web API/v1-Order Status

Get all OrderStatus Get an OrderStatus

3d Cart Web API/v1-Payment Tokens

Get all Payment Tokens Get a Payment Token This method is used to update a single paymenttoken record in the database. The {paymenttokenid} parameter specifies which paymenttoken record to update.

3d Cart Web API/v1-Products-{catalogid}-Advanced Options

Get the advanced options from a specific Product Updates specific advanced options from a specific Product

3d Cart Web API/v1-Products-{catalogid}-Discount

Get the discounts from a specific Product Updates a specific discount from a specific Product

3d Cart Web API/v1-Products-{catalogid}-E Products

Get the EProducts from a specific Product Updates a specific eproduct from a specific Product

3d Cart Web API/v1-Products-{catalogid}-Features

Get the features from a specific Product Updates a specific feature from a specific Product

3d Cart Web API/v1-Products-{catalogid}-Images

Get the images from a specific Product Updates a specific image from a specific Product

3d Cart Web API/v1-Products-{catalogid}-Options

Get the options from a specific Product Updates specific options from a specific Product

3d Cart Web API/v1-Products-{catalogid}-Related

Get the related products from a specific Product Updates a specific related product from a specific Product

3d Cart Web API/v1-Products-{catalogid}-Serials

Get the serials from a specific Product Updates a specific serial from a specific Product

3d Cart Web API/v1-Products-{catalogid}-Up Selling

Get the upselling products from a specific Product Updates a specific Upselling Item from a specific Product

3d Cart Web API/v1-Products-{catalogid}

Get a product Get the categories from a specific Product Get the distributors from a specific Product Get all products (SKUInfo section only)

3d Cart Web API/v1-Products

Get all products Get all products (SKUInfo section only)

3d Cart Web API/v1-Promotions

Get all Promotions Get a Promotion This method is used to update a single promotion record in the database. The {promotionid} parameter specifies which promotion to update.

3d Cart Web API/v1-RMA-{rmaid}

Get a specific RMA Gets the items from a specific RMA

3d Cart Web API/v1-RMA

3d Cart Web API/v1-Webhooks

Get all Webhooks Get a Webhook Get all Events

3d Cart Web API/v1

Get the Store Settings

API REST Documentation

Get product SKUs matching to parameters specified in request Delete product SKU

Search Affiliates Get Affiliate

additionalfields-{Field Code}

Extract information about a specific additional field you set up for your account Extract additional field texts and translations.

additionalfields

Extract information about additional fields you set up for your account

Get crossSell campaigns by filter /crosssells/settings/

Working example: Retrieve cross-sell campaign texts Working example: Retrieve cross-sell campaign texts

customers-{C Reference}

Working example of how to retreive a customer Working example: SSO by customer reference Working example: SSO in cart

Working example: Retrieve Single Sign On customer info by SSOToken

invoices/{Order Reference}

Extract invoices for specific orders. The output contains the binary code for invoices in the PDF file format, Base64 encoded (Base64 is used to represent binary data in the ASCII string format).Extract invoices for specific refunds. The output contains the binary code for invoices in the PDF file format, Base64 encoded (Base64 is used to represent binary data in the ASCII string format).

Working example: Retrieve session for dynamic products Retrieve installment settings used to place orders with installments Working example: Retrieve shipping price Get order reference by invoice id Extract cost information for a product/subscription plan, based on a specific list of options.

Search orders by ApproveStatus, Newer, Status, StartDate, EndDate, ExternalRefNo having Page and Limit Working example: Retrieve an order with dynamic products Working example: Issue a partial refund

Working example: Retrieve the list of banks that support iDEAL Working example: Retrieve PayPal Express redirect URL Validate order references in order to be used for a new order using previous order as payment reference

/payouts/Retrieve account balance

Working example: Retrieve price option groups Working example: Retrieve a price options group

Retrieve product groups Retrieve a product group

products-{Product Code}-pricingconfigurations-{Code}

Working example: Retrieve a pricing configuration Working example: Retrieve SKU code by details

products-{Product Code}-pricingconfigurations

Working example: Retrieve pricing configurations Working example: Retrieve SKU details

products-{Product Code}-promotions

Working example: Retrieve all promotions set for a product Working example: Retrieve a product's promotion

products-{Product Code}

Retrieve product info by code Get crossSell campaigns by filter Working example: Retrieve a price options group Assign a product to a product group Set product upgrade schema

Retrieve subscription plan and product info

promotions-{Promotion Code}

Working example: Retrieve a promotion Working example: Update promotion coupon Working example: Add products to a promotion Working example: Add promotion sources Working example: Add promotion translations

Working example: Retrieve all active promotions

Get all shipping fees Get shipping fee

subscriptions-{Subscription Reference}-additionalinformation

Retrieve information attached to a subscription Retrieve information attached to a subscription by key

subscriptions-{Subscription Reference}-history

Retrieve the history of a subscription Retrieve a subscription's purchase, renewal or upgrade details

subscriptions-{Subscription Reference}-renewal

Retrieve renewal links and recurring billing status Set a custom grace period Enable renewal notification Retrieve a subscription's next renewal price Convert a trial Retrieve a subscription's pause information Trigger immediate billing for a pay per usage subscription

subscriptions-{Subscription Reference}-upgrade

Retrieve upgrade options for a subscription Retrieve product upgrade price for a subscription

subscriptions-{Subscription Reference}-usages

Filter usages for a subscription Update a specific usage entry

subscriptions-{Subscription Reference}

Retrieve a subscription Retrieve a subscription’s customer Retrieve a subscription's end user Retrieve the payment info for a subscription SSO by subscription reference

Search Subscriptions

proposals-{proposal Id}

Retrieve a proposal Execute an action on the proposal

Search proposals

Search shipping methods Search Leads

Post Webhook Create Get Webhook List Get Webhook Count Get Webhook Events Delete Webhook Delete Put Webhook Update Post Cart Create Get Cart Validate Get Cart List Get Cart Bridge Delete Cart Delete Get Cart Disconnect Get Cart Methods Get Cart Config Put Cart Config Update Get Cart Coupon Count Get Cart Coupon List Get Cart Giftcard Count Get Cart Giftcard List Post Cart Giftcard Add Post Cart Coupon Add Post Cart Coupon Condition Add Delete Cart Coupon Delete Get Cart Script List Post Cart Script Add Delete Cart Script Delete Get Cart Info Post Cart Clear Cache Get Cart Plugin List Get Cart Shipping Zones List Get Account Cart List Post Account Cart Add Put Account Config Update Get Account Failed Webhooks Get Account Supported Platforms Get Bridge Download File Post Bridge Update Post Bridge Delete Get Product List Get Product Count Get Product Info Get Product Find Get Product Fields Post Product Add Put Product Update Delete Product Delete Post Product Price Add Put Product Price Update Delete Product Price Delete Post Product Image Add Put Product Image Update Delete Product Image Delete Get Category List Get Category Count Get Category Info Get Category Find Post Category Add Put Category Update Delete Category Delete Post Category Assign Post Category Unassign Post Category Image Add Delete Category Image Delete Get Order Count Get Order List Get Order Info Get Order Find Post Order Add Put Order Update Get Order Status List Get Order Financial Status List Get Order Abandoned List Get Order Shipment List Post Order Shipment Add Put Order Shipment Update Post Order Shipment Tracking Add Post Order Refund Add Get Basket Live Shipping Service List Get Basket Info Post Basket Live Shipping Service Create Delete Basket Live Shipping Service Delete Get Customer List Get Customer Count Get Customer Info Get Customer Find Post Customer Add Get Attribute List Get Attribute Info Get Attribute Count Get Attribute Type List Delete Attribute Delete Post Attribute Add Post Attribute Assign Group Post Attribute Assign Set Post Attribute Unassign Group Post Attribute Unassign Set Get Attribute Group List Get Attribute Attributeset List Get Product Attribute List Post Product Attribute Value Set Post Product Option Add Get Product Option List Post Product Option Assign Post Product Option Value Add Post Product Option Value Assign Put Product Option Value Update Get Product Review List Post Product Variant Add Get Product Child Item Info Get Product Child Item List Get Product Child Item Find Get Product Variant List Get Product Variant Info Get Product Variant Count Put Product Variant Update Delete Product Variant Delete Post Product Variant Price Add Put Product Variant Price Update Delete Product Variant Price Delete Post Product Tax Add Post Product Manufacturer Add Get Product Brand List Post Product Currency Add Get Product Currency List Post Product Store Assign Get Tax Class Info Post Basket Item Add Get Subscriber List Get Bridge Download

Adyen Checkout API

Starts a transaction.Submits details for a payment.Verifies payment result.

Creates a payment link.Returns available payment methods.Creates a payment session.

Adyen Checkout Utility Service

Create originKey values for one or more merchant domains.

Adyen MarketPay Account API

Request to perform verification for an account holder.Close an existing account under an account holder.Close an existing account holder.Create a new account under an existing account holder.Create a new account holder.Delete bank accounts of an existing account holder.Delete payout methods of an existing account holder.Delete shareholders of an existing account holder.Retrieve the details of an account holder.Retrieve the uploaded documents of an existing account holder.Suspend an existing account holder.Reinstate a disabled account holder.Update an existing account under an account holder.Update an existing account holder.Update the state of an existing account holder.Upload a document for an existing account holder.

Adyen MarketPay Account Service

Close an existing account under an account holder.Close an existing account holder.Create a new account under an existing account holder.Create a new account holder.Delete bank accounts of an existing account holder.Delete shareholders of an existing account holder.Retrieve the details of an account holder.Retrieve the uploaded documents of an existing account holder.Suspend an existing account holder.Reinstate a disabled account holder.Update an existing account under an account holder.Update an existing account holder.Update the state of an existing account holder.Upload a document for an existing account holder.

Adyen MarketPay Fund API

Retrieve the balance(s) of an account holder.Retrieve a list of transactions.Disburse a specified amount from an account to the account holder.Make a refund of the existing transfer funds transfer.Refund all transactions of an account since the most recent payout.Designate an account to be the beneficiary of a separate account and transfer the benefactor's current balance to the beneficiary.Transfer funds from one platform account to another.

Adyen MarketPay Fund Service

Retrieve the balance(s) of an account holder.Retrieve a list of transactions.Disburse a specified amount from an account to the account holder.Refund all transactions of an account since the most recent payout.Designate an account to be the beneficiary of a separate account and transfer the benefactor's current balance to the beneficiary.Transfer funds from one platform account to another.

Adyen MarketPay Notification Configuration API

Configure a new subscription to notifications.Delete an existing notification subscription configuration.Retrieve an existing notification subscription configuration.Retrieve a list of existing notification subscription configurations.Test an existing notification configuration.Update an existing notification subscription configuration.

Adyen Payment API

Increases or decreases the authorised amount.Creates a payment authorisation.Completes a 3D Secure payment authorisation.Completes a 3D Secure 2 payment authorisation.Cancels an authorised payment.Cancels or refunds a payment.Captures an authorised payment.Return the authentication result after doing a 3D Secure authentication only.Refunds a captured payment.Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.Cancels a payment using your custom reference.Cancels a POS refund request before it has been completed.

Adyen Payout API

Confirms a payout.Cancels a payout.Pay out directly.Stores payout details.Stores details and submits a payout.Submits a payout.

Adyen Recurring API

Disables stored payment details.Retrieves stored payment details for a shopper.Schedules running of the Account Updater.

Adyen Recurring Service

Disables stored payment details.Retrieves stored payment details for a shopper.

rest/v1-assets-paint-reference-files/no-locale

asset reference file (2.1 only)download asset reference file (2.1 only)

rest/v1-assets-paint-variation-files/ecommerce/no-locale

asset variation file (2.1 only)download asset variation file (2.1 only)

rest/v1-assets-paint

asset (2.1 only)

assets (2.1 only)

rest/v1-asset-categories

asset categories (2.1 only)asset category (2.1 only)asset category (2.1 only)

rest/v1-asset-tags

asset tags (2.1 only)asset tag (2.1 only)

rest/v1-association-types

association types (2.x only)association type (2.x only)

rest/v1-attributes-main color/options

attribute options attribute option

rest/v1-attributes

attributes attribute

rest/v1-attribute-groups

attribute groups (2.x only)attribute group (2.x only)

rest/v1-categories

categories category category

rest/v1-channels

channels channel channel (2.x only)

rest/v1-currencies

currencies (2.x only)currency (2.x only)

rest/v1-families-clothing/variants

family variants (2.x only)family variant (2.x only)

rest/v1-families

families family

rest/v1-locales

rest/v1-measure-families

measure families (2.x only)measure family (2.x only)

rest/v1-media-files

rest/v1-products-AKNTS BPS

draft (2.x and EE only)proposal (2.x and EE only)

rest/v1-products

products product product

rest/v1-product-models-amor

product model (2.x only)draft (2.3 and EE only)proposal (2.3 and EE only)

rest/v1-product-models

product models (2.x only)

rest/v1-published-products

published products (2.x and EE only)published product (2.x and EE only)

Authentification by refresh token

Digital River Shopper

Get Oauth20 Authorize Post Oauth20 Token

v1-shoppers-me-addresses

Get Shoppers Me Addresses Get Shoppers Me Addresses

v1-shoppers-me-carts/active-line-items

Delete Shoppers Me Carts Active Line Items Delete Shoppers Me Carts Active Line Items

v1-shoppers-me-carts/active-shipping-options

Get Shoppers Me Carts Active Shipping Options Get Shoppers Me Carts Active Shipping Options

v1-shoppers-me-carts/active

Get Shoppers Me Carts Active Post Shoppers Me Carts Active Apply Shipping Option Post Shoppers Me Carts Active Apply Shopper Get Shoppers Me Carts Active Billing Address Get Shoppers Me Carts Active Point Of Promotions Offers Get Shoppers Me Carts Active Shipping Address Post Shoppers Me Carts Active Submit Cart Get Shoppers Me Carts Active Web Checkout

v1-shoppers-me-categories-{id}

Get Shoppers Me Categories Get Shoppers Me Categories Products

v1-shoppers-me-categories

Get Shoppers Me Categories

v1-shoppers-me-orders-{id}-line-items

Get Shoppers Me Orders Line Items Get Shoppers Me Orders Line Items Lineitemid

v1-shoppers-me-orders-{id}

Get Shoppers Me Orders Get Shoppers Me Orders Billing Address Get Shoppers Me Orders Shipping Address

v1-shoppers-me-orders

Get Shoppers Me Orders

v1-shoppers-me-payment-options

Get Shoppers Me Payment Options Get Shoppers Me Payment Options

v1-shoppers-me-point-of-promotions/{id}/offers-{offer Id}-product-offers

Get Shoppers Me Point Of Promotions Offers Offerid Product Offers Get Shoppers Me Point Of Promotions Offers Offerid Product Offers Productid

v1-shoppers-me-point-of-promotions/{id}/offers-{offer Id}

Get Shoppers Me Point Of Promotions Offers Offerid

v1-shoppers-me-point-of-promotions/{id}/offers

Get Shoppers Me Point Of Promotions Offers

v1-shoppers-me-products-{id}

Get Shoppers Me Products Get Shoppers Me Products Point Of Promotions Popid Offers Post Shoppers Me Products Purchase Get Shoppers Me Products Variations

v1-shoppers-me-products

Get Shoppers Me Products

v1-shoppers-me-purchase-plan

Post Shoppers Me Purchase Plan Authorize Get Shoppers Me Purchase Plan Search

Get Shoppers Me Get Shoppers Me Account Get Shoppers Me Product Search

Post Shoppers Get Shoppers Token

Get Shoppers Api

Get Item Get Item Get Item By Legacy Get Item Get Items By Item Group Get Item Item

merchandised product

Get Merchandised Product Get Merchandised Product Get Also Bought Products Get Merchandised Product Get Also Viewed Products

category tree/{category tree id}

Get Category Tree Category Tree Get Category Tree Category Tree Get Category Subtree Get Category Tree Category Tree Get Category Suggestions Get Category Tree Category Tree Get Item Aspects For Category

order-{order Id}-shipping fulfillment

Get Order Order Shipping Fulfillment Get Order Order Shipping Fulfillment Fulfillment

order-{order Id}

Get Order Order

Get Item Summary Search Get Item Description Get Get Default Category Tree

Get all product classes Get product class details Delete custom product class

orders-SET-ORDER-ID-items/SET-ORDER-ITEM-ID/options/SET-OPTION-NAME

Upload a new product option file for a purchased item Delete a product option file

orders-SET-ORDER-ID

Get order details

Search orders by keywords Get deleted orders

Search customers Get customer details Get deleted customers

categories-SET-CATEGORY-ID

Get category details Upload / add category icon

Get all categories

Get a store profile Add / upload store logo Add / upload invoice logo

products-SET-PRODUCT-ID-gallery

Upload additional (gallery) product image Delete one additional (gallery) product image

products-SET-PRODUCT-ID-combinations-SET-COMBINATION-ID

Get a specific combination Add / upload a product combination image

products-SET-PRODUCT-ID-combinations

Get all combinations for a product

products-SET-PRODUCT-ID-files

Add product file (e-goods)Delete product file

products-SET-PRODUCT-ID

Get product details Add / Update product image

Show "out of stock" products Update product options Get deleted products

discount coupons

Get all discount coupons Get a discount coupon Get deleted coupons

Get stats about product/order/profile updates

Delete Products Put Products Enable

products-:product id-custom fields

Get Products Custom Fields Put Products Custom Fields Name

products-:product id-offer codes

Get Products Offer Codes Get Products Offer Codes

products-:product id-variant categories-:variant category id/variants

Post Products Variant Categories Variant Category Variants Delete Products Variant Categories Variant Category Variants

products-:product id-variant categories

Get Products Variant Categories Delete Products Variant Categories

countries-{country code}

Get Countries Country Code Regions Get Countries Country Code Regions Region Code

Get Countries Country Code

customer categories

Delete Customer Categories Delete Customer Categories Customers

Get Customers Email Email Delete Customers

Get Orders Status Status Get Orders Get Orders History

products-category

Get Products Category Category Get Products Category Category Count

products-status

Get Products Status Status Get Products Status Status Count

products-{id}-images

Get Products Images Count Delete Products Images Image

products-{id}-options-{option id}-values

Get Products Options Option Values Count Delete Products Options Option Values Value

products-{id}-options-{option id}

Get Products Options Option Values

products-{id}-options

Get Products Options Count Delete Products Options Option

products-{id}-variants

Get Products Variants Count Get Products Variants Variant

Get Products Fields Get Products Fields Count Get Products Images Get Products Options Get Products Variants

Get Products After Get Products Count Get Products Search Get Products Sku Sku Delete Products

Get Store Info Get Store Languages

Get Apps Get Categories Delete Categories Get Checkout Custom Fields Delete Checkout Custom Fields Get Countries Get Customer Categories Get Customers Get Fields Get Hooks Delete Hooks Post Jsapps Delete Jsapps Code Get Orders Get Payment Methods Get Payment Methods Get Products Get Promotions Delete Promotions Post Settings Get Settings Name

Retrieve the product for the specified ASIN and domain.Returns Amazon category information from Keepa API.

Logicbroker Commerce

api/v1-Acknowledgements-{Logicbroker Key}-Status

Retrieve acknowledgement status Update acknowledgement status

api/v1-Acknowledgements-{Logicbroker Key}

Get acknowledgement details Retrieve EDI

api/v1-Acknowledgements

Search acknowledgements Create acknowledgement(s) based on custom XML.Request an acknowledgement from a trading partner Export to CSV/XLSX Import from flat file.

api/v1-Activity Events

Get events for given fitlers Gets the event with the specified id.Gets a list of all possible event types.

api/v1-Attachments

Get a list of all attachments matching a given filter.Retrieve a file from Logicbroker storage.

api/v1-Inventory-{partner Id}

Download inventory as CSV.Match items with CSV.Resend all inventory items.Get a single item by SKU

api/v1-Inventory

Import inventory from CSV.Get the availability of an item across all suppliers.

api/v1-Invoices-{Logicbroker Key}-Status

Return the current status code of an invoice.Updates an invoice to the specified status.

api/v1-Invoices-{Logicbroker Key}

Returns the invoice with the specified key.Retrieve related events Retrieve EDI

api/v1-Invoices

Get invoices based on provided filters Create invoice(s) based on custom XML.Import from flat file.Export to CSV/XLSX

api/v1-Orders-{Logicbroker Key}-Status

Retrieve order status Update order status

api/v1-Orders-{Logicbroker Key}

Retrieve an order Retrieve a list of invoices for an order Retrieve a list of shipments for an order Retrieve related events Retrieve a list of returns for an order Retrieve EDI Get pick list for one order Get shipping/tracking label options.Generate a tracking label for a given package

Search orders Create order(s) based on custom XML.Import from flat file.Export to CSV/XLSX Get pick lists for multiple orders

api/v1-Product/{partner Id}-{feed Id}-Items

Get items in the product feed.Get product feed item.

api/v1-Product/{partner Id}-{feed Id}

Get product feed status.

api/v1-Product/{partner Id}

Import product from CSV.

api/v1-Returns-{Logicbroker Key}-Status

Retrieve return status Update return status

api/v1-Returns-{Logicbroker Key}

Get return details Retrieve EDI

Search returns Create return(s) based on custom XML.Request a return Export to CSV/XLSX Import from flat file.

api/v1-Shipments-{Logicbroker Key}-status

Get shipment status Update shipment status

api/v1-Shipments-{Logicbroker Key}

Get shipment details Retrieve related events Retrieve EDI Get packing slips for one shipment Get shipping labels for one shipment.

api/v1-Shipments

Get shipments for given filters Create shipment(s) based on custom XML.Import from flat file.Export to CSV/XLSX Get packing slips for multiple shipments Get shipping labels for multiple shipments Gets a new SSCC18 container code.

api/v1-Statuses

Get configured document statuses for each document Get configured document statuses for each document

api/v1-Webhooks-{Webhook Id}

Get webhook details Test a webhook endpoint.

api/v1-Webhooks

Get list of webhooks

Execute custom handler.Retrieve a list of trading partners.

admin-script tags

Get a single script tag update a script tag Get a count of all script tags

admin-comments-2941387470

Mark a comment as Spam Remove a comment Approve a comment Mark a comment as not spam restore a comment

Update a comment Get a single comment Get a count of all comments

admin-smart collections

Get a single collection Get a count of all collections Delete a single collection

admin-products-7990943555-metafields

Get a count of all metafields that belong to a product Get a single product metafield using the metafield's nested resource path

admin-products-7990943555-variants

Get a count of variants for a product Delete a product variant

admin-products-7990943555-images

Get a single product image by id Get a count of all product images

admin-products-7990943555

Get all product images Get all variants for a product Get all metafields that belong to a product Get all the events from a particular product

Update a product and one of its variants Count all products Get a single product

admin-orders-4554953422-refunds

Calculate a refund for a line item and shipping Get a representation of a single refund

admin-orders-4554953422-transactions

Get a count of transactions for an order Get a specific transaction

admin-orders-4554953422

Canceling an Order Close a processed order Get all the events from a particular order Get all refunds from a specific order Re-opening a closed Order Get all transactions for an order

admin-orders-4602125518

Get all Order Risks for an Order Get a single Order Risk

admin-orders-4495703502-fulfillments/3763917198

Delete a fulfillment event.Create a fulfillment event.

admin-orders-4495703502

Get a list of all fulfillments for an order.

admin-orders-4528049998/fulfillments-3770145678

Cancel a fulfillment.Complete a fulfillment.Fetch a fulfillment event.Transition a fulfillment from pending to open.Get a list of all fulfillment events for a fulfillment

admin-orders-4528049998/fulfillments

Get the Representation of a specific fulfillment.Count all the total number of fulfillments for an order.

Get a representation of a single order Count all orders

admin-collects.json

List all collects Add a product to a collection

admin-blogs-62581763-articles

Get a single article by its ID and the ID of the parent blog Get a count of all articles from a certain blog Delete an article of a blog tags of articles

admin-blogs-62581763

Get a list of all articles from a certain blog

Update a blog Get a single blog by its ID Get a count of all blogs

admin-gift cards

Disable a gift card Show a specific gift card's details Retrieve a count of all gift cards Update the expiry date of a gift card Get all gift cards that matches the query

Update a Webhook Get a count of all webhooks for your shop.Get a single webhook by its id.

admin-metafields

Get a single store metafield by ID Get a count of all metafields for a store

Count all pages for a shop update a page Get a single page by its ID

admin-customers-3989659651-addresses

Updating a customers postal code assigning a new default address to a customer destroying multiple customer addresses Get a single customers address

admin-customers-3989659651

Get all of a customer's addresses

admin-customers

Get all customers with an address in the Brazil Add metafield to an existing customer Get a single customer by ID Get a count of all customers

admin-custom collections

Get a single custom collections Get a count of all custom collections

admin-comments.json

Create a new comment for an article Get a list of all comments

Get a list of all the tags of articles Get a list of all the authors of articles

Update an existing product variant Get a product variant by id

admin-customer saved searches

Get all customers who match the criteria Get a count of all customer saved searches Update an existing Customer Saved Search Get one customer saved search by ID

Shows the same fields as the list action.Count all the events

admin-countries-261414723-provinces

Get a count of all provinces get a single province

admin-countries-261414723

Get all provinces

admin-countries

update a country Show Country Get a count of all countries

Return a collect with a certain id Remove a product from a collection Get a count of all collects

admin-discounts-2951196163

Disable a discount Enable a discount

admin-discounts

Retrieve a discount

Get a list of all theme assets Get a single theme Update a theme's attributes

admin-redirects

Get a countt of all URL redirect Update a redirect Get a single URL redirect

admin-application charges

Activate a one-time charge Retrieve one-time application charge

Get a list of all custom collections Get all metafields that belong to a store Get a list of all blogs getting the shops policies Get a list of all countries List your app's fulfillment services Retrieving all one-time charges since a specified ID Get a list of all gift cards Get all collection Get a single location Get a list of all webhooks for your shop.Get all orders from a customer List carrier services Get a single fulfillment service by its ID Get a list of all pages List all discounts Get a list of all locations for a shop Update a carrier service List all abandoned checkouts Get all customer saved searches for a shop Get a list of all URL redirect Get a list of all script tags Get the configuration of the shop account Get all products Create a new charge Retrieve all customers Get all shop themes Show list of shipping zones Get a count of checkouts

Hack Authentication

v2-customers-{customer id}-cards

Post Customers Cards Delete Customers Cards

v2-customers-{customer id}

Delete Customers

v2-locations-{location id}-transactions-{transaction id}

Get Locations Transactions Post Locations Transactions Capture Post Locations Transactions Refund Post Locations Transactions Void

v2-locations-{location id}-transactions

Get Locations Transactions

v2-locations-{location id}

Get Locations Refunds Post Locations Checkouts

v2-catalog-object

Post Catalog Object Delete Catalog Object

Post Catalog Batch Delete Post Catalog Batch Retrieve Post Catalog Batch Upsert Get Catalog Info Get Catalog List Post Catalog Search Post Catalog Update Item Modifier Lists Post Catalog Update Item Taxes

v1-me-employees

Get Me Employees Get Me Employees

Get Me Roles Get Me Roles

v1-me-timecards-{timecard id}

Delete Me Timecards Get Me Timecards Events

v1-me-timecards

Get Me Timecards

Get Me Get Me Locations

v1-{location id}-bank-accounts

Get Location Bank Accounts Get Location Bank Accounts Bank Account

v1-{location id}-cash-drawer-shifts

Get Location Cash Drawer Shifts Get Location Cash Drawer Shifts

v1-{location id}-categories

Get Location Categories Delete Location Categories Category

v1-{location id}-discounts

Get Location Discounts Delete Location Discounts

v1-{location id}-fees

Get Location Fees Delete Location Fees

v1-{location id}-inventory

Get Location Inventory Post Location Inventory Variation

v1-{location id}-items-{item id}-variations

Post Location Items Variations Delete Location Items Variations

v1-{location id}-items-{item id}

Delete Location Items Delete Location Items Fees Delete Location Items Modifier Lists Modifier List

v1-{location id}-items

Get Location Items

v1-{location id}-modifier-lists-{modifier list id}-modifier-options

Post Location Modifier Lists Modifier List Modifier Options Delete Location Modifier Lists Modifier List Modifier Options Modifier Option

v1-{location id}-modifier-lists-{modifier list id}

Delete Location Modifier Lists Modifier List

v1-{location id}-modifier-lists

Get Location Modifier Lists

v1-{location id}-orders

Get Location Orders Get Location Orders

v1-{location id}-pages-{page id}

Delete Location Pages Delete Location Pages Cells

v1-{location id}-pages

Get Location Pages

v1-{location id}-payments

Get Location Payments Get Location Payments

v1-{location id}-settlements

Get Location Settlements Get Location Settlements

v1-{location id}

Get Location Refunds

Walmart Marketplace API

tokenGeneration_authentication tokenDetails_authentication

bulkUpdateInventory getFeedStatusWODetails

getAllItemsWithNextCursor getItem retireItem

v3-orders-4793302295726

getOrder ackOrder

getAllOrders getAllReleasedOrders cancelOrderLine refundOrderLine shippingOrderLine

getReturns issueRefund

v3-rules-{rule Id}/status/{rule Status}

deleteRule getSimulationResult downloadSimulationResult

getAllRules getARules createItemRule updateShippingAreasToRules inactivateRule createOverrideExceptions changeAssortmentType downloadExceptions getAllSubCategories getAllAreas

v3-settings-shipping-shipnodes

createFulfillmentCenter updateAFulfillmentCenter getCoverageForFulfillmentCenters

v3-settings-shipping

createThirdPartyFulfillmentNode getAllThirdPartyFulfillmentProviders getCarrierMethods

deleteExceptions

updateInventory updatePrice setupCAPskuAll getPromoPrice getLagtime getItemReport

Home Akeneo PIM rest/v1-assetsassets (2.1 only)

assets (2.1 only)

GET {{baseUrl}}/rest/v1/assets?limit=<>&with_count=<>

Assets (2.1 only).

Request Params

Key	Datatype	Required	Description
`limit`	string
`with_count`	string

rest/v1-asset-categories