Magento Integration

Are you looking for a customisable Magento integration solution to integrate Magento with your accounting, ERP or CRM system and remove time-consuming and error prone order processing? Or are you looking to improve order fulfilment times by integrating Magento with your courier service?

Codeless Platforms' flexible Magento ERP Integration connector automates the delivery of online activity between your Magento store and business software to remove the need for manual administration. Our Magento API connector is a proven and cost effective solution that enables you to create standard and complex integrations with the powerful eCommerce solution, Magento and Magento 2.

Download Brochure

Magento Integration Features and Benefits

Standard operations of the Magento ERP connector include the following:

  • Download sales orders from Magento to your ERP system: The automated download of your Magento orders will include key information such as: Customer shipping details, delivery method and timeframe (as selected by the customer), product description, product code and quantity required, payment details including Transaction IDs.
  • Upload ERP sales order status to Magento: Once an order has been fulfilled in your ERP business system, your customer can be automatically alerted to the following: Order status updates, courier tracking information.
  • Part shipment: Allow items of an order to be shipped as they become available. Allow an order to be closed before all items are shipped.
  • Download stock levels from Magento: Online stock levels will be downloaded at scheduled intervals. This will allow for comparison against the stock levels held within your ERP system. It will also assist with keeping your inventory up to date within your Magento store.
  • Upload ERP stock level and price changes to Magento: Your Magento store is automatically updated to reflect product related changes made within your ERP business system, such as: Product stock levels, product price changes.

Custom Magento Integration features:

The Magento API integration solution is open to customisation which allows it to be tailored to your exact business requirements. This means that certain features are not available as standard but can be implemented through future design if you wish.

Below are some examples of features that can be added. The list is not exhaustive but aims to provide an idea of how the Magento integration solution could be expanded to suit your eCommerce process flow.

When downloading a sales order to your business system:

  • Configurable products: This accomodates the bespoke customisation of a product where multiple choice options wihtin a product listings are available. As standard, each selection made within the listing must have a unique SKU code and existin within your product inventory.
  • Multiple payment methods: Allows payments to be split. This enables payments for one half and a payment method for the other.
  • Payment reconciliation: Provides the ability to automatically check if a payment for an order has successfully reached the vendors bank account before an order can be shipped.

When uploading ERP stock levels and price changes to your Magento eCommerce store:

  • Magento stock levels and prices inaccessible: Product stock levels and prices are obtained solely from your ERP system. These can be customised to query your inventory on Magento to obtain an aggregate figure.

Common commercial benefits achieved by integrating Magento with ERP and other systems include:

  • Eradication of repetitive data entry and associated human errors
  • Improved Magento order management processes
  • Significant decrease in order to dispatch times
  • Reduction in operational costs and the need to recruit temporary seasonal employees
  • Improved Magento inventory management and increased visibility of inventory levels
See BPA Platform in action. Download Brochure

Magento Integration starts from...

Connector Pricing

Magento

One time purchase

$998

BPA Server

Standard Product Base Server

Starts from:

$2,527

Magento API Documentation

View the Magento API Objects and Functions exposed by our Connector

Backend

Returns an array of enabled modules.

Get

  • Get Modules

Bundle

Bundle Products and Options

Delete

  • Delete bundle products sku options option Id
  • Delete bundle products sku options option Id children child Sku

Get

  • Get bundle products options types
  • Get bundle products product Sku children
  • Get bundle products sku options all
  • Get bundle products sku options option Id

Post

  • Post bundle products options add
  • Post bundle products sku links option Id

Put

  • Put bundle products options option Id
  • Put bundle products sku links Id

Catalogue

Catalogue Management

Delete

  • Delete categories category Id
  • Delete categories category Id products sku
  • Delete products attributes attribute Code
  • Delete products attributes attribute Code option Id
  • Delete products SKU
  • Delete products sku group prices customer Group Id tiers qty
  • Delete products sku links type linked Product Sku
  • Delete products sku media entry Id
  • Delete products sku options option Id

Get

  • Get categories
  • Get categories attributes
  • Get categories attributes attribute Code
  • Get categories attributes attribute Code options
  • Get categories category Id
  • Get categories category Id products
  • Get products
  • Get products attributes
  • Get products attributes attribute Code
  • Get products attributes attributes Code options
  • Get products attributes types
  • Get products links type attributes
  • Get products links types
  • Get products options types
  • Get products SKU
  • Get products sku group prices customer Group Id tiers
  • Get products sku links type
  • Get products sku media
  • Get products sku media entry Id
  • Get products sku options
  • Get products sku options option Id
  • Get products types

Post

  • Post categories
  • Post categories category Id products
  • Post products
  • Post products attribute sets
  • Post products attribute sets attributes
  • Post products attributes
  • Post products attributes attribute Code options
  • Post products options
  • Post products sku group prices customer Group Id tiers qty price
  • Post products sku links
  • Post products sku media
  • Post productsattribute sets groups

Put

  • Put categories category Id move
  • Put categories category Id products
  • Put categories Id
  • Put products attributes attribute Code
  • Put products options option Id
  • Put products SKU
  • Put products sku links
  • Put products sku media entry Id

set

  • Delet products attribute sets attribute Set Id attributes attribute Code
  • Delete products attribute sets attribute Set Id
  • Delete products attribute sets groups group Id
  • Get products attribute sets attribute Set Id
  • Get products attribute sets attributeSet Id attributes
  • Get products attribute sets groups list
  • Get products attribute sets sets list
  • Get products media types attribute Set Name
  • Put products attribute set Set Id
  • Put products attribute sets attribute Set Id groups

Catalogue Inventory

Catalogue Inventory Management

Get

  • Get stock Items low Stock
  • Get stock Items product Sku
  • Get stock Statuses product Sku

Put

  • Put products product Sku stock Items item Id

Checkout

Checkout Management 

Get

  • Get carts mine payment information
  • Get guest carts cart Id payment information

Post

  • Post carts cart Id shipping information
  • Post carts cart Id totals information
  • Post carts mine payment information
  • Post carts mine set payment information
  • Post carts mine shipping information
  • Post carts mine totals information
  • Post guest carts cart Id payment information
  • Post guest carts cart Id set payment information
  • Post guest carts cart Id totals information

Checkout Agreements

Checkout Agreements Management

Get

  • Get carts licence

CMS

CMS Management

Delete

  • Delete cms Block block Id
  • Delete cms Page page Id

Get

  • Get cms Block block Id
  • Get cms Block search
  • Get cms Page Id
  • Get cms Page search

Post

  • Post cms Block
  • Post cms Page

Put

  • Put cms Block Id
  • Put Cms Page id

Configurable Product

Configuring Products

Delete

  • Delete configurable products sku children child Sku
  • Delete configurable products sku options Id

Get

  • Get configurable products sku children
  • Get configurable products sku options all
  • Get configurable products sku options Id

Post

  • Post configurable products sku child
  • Post configurable products sku options

Put

  • Put configurable products sku options Id
  • Put configurable products variation

Customer

Customer Management

Delete

  • Delete addresses address Id
  • Delete customer Groups Id
  • Delete customers customer Id

Get

  • Get attribute Metadata customer
  • Get attribute Metadata customer Address
  • Get attribute Metadata customer Address attribute attribute Code
  • Get attribute Metadata customer Address custom
  • Get attribute Metadata customer Address form form Code
  • Get attribute Metadata customer attribute attribute Code
  • Get attribute Metadata customer custom
  • Get attribute Metadata customer form form Code
  • Get customer Groups default
  • Get customer Groups default store Id
  • Get customer Groups I+E81d
  • Get customer Groups Id permissions
  • Get customer Groups search
  • Get customers addresses address Id
  • Get customers customer Id
  • Get customers customer Id billing Address
  • Get customers customer Id confirm
  • Get customers customer Id permissions read only
  • Get customers customer Id shipping Address
  • Get customers me
  • Get customers me billing Address
  • Get customers me shipping Address
  • Get customers search

Post

  • Post customer Groups
  • Post customers
  • Post customers confirm
  • Post customers is Email Available

Put

  • Put customer Groups Id
  • Put customers email activate
  • Put customers Id
  • Put customers me
  • Put customers me activate
  • Put customers me password
  • Put customers password
  • Put customers validate

set

  • Get customers customer Id password reset Link Token reset Password Link Token

Directory

Directory Management

Get

  • Get directory countries
  • Get directory countries country Id
  • Get directory currency

Downloadable

Product Link Management

Delete

  • Delete products downloadable links Id
  • delete products downloadable links samples Id

Get

  • Get products sku downloadable links
  • Get products sku downloadable links samples

Post

  • Post products sku downloadable links
  • Post products sku downloadable links samples

Put

  • Put products sku downloadable links Id
  • Put products sku downloadable links samples Id

Eav

Attributes Management

Post

  • Post eav attribute sets

set

  • Delete eav attribute sets attribute Set Id
  • Get eav attribute sets attribute Set Id
  • Get eav attribute sets list
  • Put eav attribute sets attribute Set Id

Gift Message

Management of Gift Messaging

Get

  • Get carts cart Id gift message
  • Get carts cart Id gift message item Id
  • Get carts mine gift message
  • Get carts mine gift message item Id
  • Get guest carts cart Id gift message
  • Get guest carts cart Id gift message item Id

Post

  • Post carts cart Id gift message
  • Post carts cart Id gift message item Id
  • Post carts mine gift message
  • Post carts mine gift message item Id
  • Post guest carts cart Id gift message
  • Post guest carts cart Id gift message item Id

Integration

Integration Management

Post

  • Post integration admin token
  • Post integration customer token

Quote

Quote Management

Delete

  • Delete carts cart Id coupons
  • Delete carts cart Id items item Id
  • Delete carts mine coupons
  • Delete carts mine items item Id
  • Delete guest carts cart Id coupons
  • Delete guest carts cart Id items item Id

Get

  • Get carts
  • Get carts cart Id
  • Get carts cart Id billing address
  • Get carts cart Id coupons
  • Get carts cart Id items
  • Get carts cart Id payment methods
  • Get carts cart Id selected payment method
  • Get carts cart Id selected shipping method
  • Get carts cart Id shipping address
  • Get carts cart Id shipping methods
  • Get carts cart Id totals
  • Get carts mine
  • Get carts mine billing address
  • Get carts mine coupons
  • Get carts mine items
  • Get carts mine payment methods
  • Get carts mine selected payment method
  • Get carts mine selected shipping method
  • Get carts mine shipping address
  • Get carts mine shipping methods
  • Get carts mine totals
  • Get guest carts cart Id
  • Get guest carts cart Id billing address
  • Get guest carts cart Id coupons
  • Get guest carts cart Id items
  • Get guest carts cart Id payment methods
  • Get guest carts cart Id selected payment method
  • Get guest carts cart Id selected shipping method
  • Get guest carts cart Id shipping address
  • Get guest carts cart Id shipping methods
  • Get guest carts cart Id totals

Post

  • Post carts
  • Post carts cart Id billing address
  • Post carts items
  • Post carts mine
  • Post carts mine billing address
  • Post carts mine estimate shipping methods
  • Post carts mine estimate shipping methods by address Id
  • Post carts mine items
  • Post carts mine shipping address
  • Post cartscart Id shipping address
  • Post customers customer Id carts
  • Post guest carts
  • Post guest carts cart Id billing address
  • Post guest carts cart Id estimate shipping methods
  • Post guest carts cart Id shipping address
  • Post guest carts items

Put

  • Put carts cart Id
  • Put carts cart Id coupons coupon Code
  • Put carts cart Id order
  • Put carts cart Id selected payment method
  • Put carts cart Id selected shipping method
  • Put carts items item Id
  • Put carts mine collect totals
  • Put carts mine coupons coupon Code
  • Put carts mine items item Id
  • Put carts mine order
  • Put carts mine selected payment method
  • Put carts mine selected shipping method
  • Put guest carts cart Id
  • Put guest carts cart Id collect totals
  • Put guest carts cart Id order
  • Put guest carts cart Id selected payment method
  • Put guest carts cart Id selected shipping method
  • Put guest carts items item Id
  • Put guest-carts cart Id coupons coupon Code

Sales

Sales Management

Delete

  • Delete shipment track Id

Get

  • Get credit memo Id comments
  • Get credit memos
  • Get creditmemo Id
  • Get invoices
  • Get invoices Id
  • Get invoices Id comments
  • Get orders
  • Get orders Id
  • Get orders Id comments
  • Get orders Id statuses
  • Get shipment Id
  • Get shipment Id comments
  • Get shipment Id label
  • Get shipments
  • Get transactions
  • Get transactions Id

Post

  • Post credit memo
  • Post credit memo Id comments
  • Post credit memo Id emails
  • Post invoices
  • Post invoices comments
  • Post invoices Id capture
  • Post invoices Id emails
  • Post invoices Id void
  • Post orders
  • Post orders Id cancel
  • Post orders Id comment
  • Post orders Id emails
  • Post orders Id hold
  • Post orders Id unhold
  • Post shipment
  • Post shipment Id comments
  • Post shipment Id emails
  • Post shipment track

Put

  • Put credit memo Id
  • Put orders create
  • Put orders parent Id

Sales Rule

Sales Rules Management

Delete

  • Delete coupons coupon Id
  • Delete sales Rules rule Id

Get

  • Get coupons coupon Id
  • Get coupons search
  • Get sales Rules rule Id
  • Get sales Rules search

Post

  • Post coupons
  • Post coupons delete By Codes
  • Post coupons delete By Id's
  • Post coupons generate
  • Post sales Rules

Put

  • Put coupons coupon Id
  • Put sales Rules rule Id

Search

Search Criteria

Get

  • Get store store Configs
  • Get store store Groups
  • Get store store Views
  • Get store websites

Tax

Tax Management

Delete

  • Delete tax Classes tax Class Id
  • Delete tax Rates rate Id
  • Delete tax Rules rule Id

Get

  • Get tax Classes search
  • Get tax Classes tax Class Id
  • Get tax Rates rate Id
  • Get tax Rates search
  • Get tax Rules rule Id
  • Get tax Rules search

Post

  • Post tax Classes
  • Post tax Rates
  • Post tax Rules

Put

  • Put tax Classes class Id
  • Put tax Rates
  • Put tax Rules

Backend Module Service V1

Interface for module service

Get

  • Get /V1/modules

Bundle Product Link Management V1

Interface for Management of Product Link

Delete

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

Get

  • Get /V1/bundle-products/{productSku}/children

Post

  • Post /V1/bundle-products/{sku}/links/{optionId}

Put

  • Put /V1/bundle-products/{sku}/links/{id}

Bundle Product Option Management V1

Option manager for bundle products

Post

  • Post /V1/bundle-products/options/add

Put

  • Put /V1/bundle-products/options/{optionId}

Bundle Product Option Repository V1

Interface Product Option Repository Interface

Delete

  • Delete /V1/bundle-products/{sku}/options/{optionId}

Get

  • Get /V1/bundle-products/{sku}/options/{optionId}
  • Get /V1/bundle-products/{sku}/options/all

Bundle Product Option Type List V1

Interface Product Option Type List Interface

Get

  • Get /V1/bundle-products/options/types

Catalog Category Attribute Option Management V1

Interface Repository Interface must be implemented in new model

Get

  • Get /V1/categories/attributes/{attributeCode}/options

Catalog Category Attribute Repository V1

Interface Repository Interface must be implemented in new model

Get

  • Get /V1/categories/attributes
  • Get /V1/categories/attributes/{attributeCode}

Catalog Inventory Stock Registry V1

Interface Stock Registry Interface

Get

  • Get /V1/stockItems/{productSku}
  • Get /V1/stockItems/lowStock/
  • Get /V1/stockStatuses/{productSku}

Put

  • Put /V1/products/{productSku}/stockItems/{itemId}

Catalog Product Attribute Repository V1

Interface Repository Interface must be implemented in new model

Delete

  • Delete /V1/products/attributes/{attributeCode}

Get

  • Get /V1/products/attributes
  • Get /V1/products/attributes/{attributeCode}

Post

  • Post /V1/products/attributes

Put

  • Put /V1/products/attributes/{attributeCode}

Catalog Product Link Repository V1

Interface Product links handling interface

Delete

  • Delete /V1/products/{sku}/links/{type}/{linkedProductSku}

Put

  • Put /V1/products/{sku}/links

Checkout Agreements Checkout Agreements Repository V1

Interface Checkout Agreements Repository Interface

Get

  • Get /V1/carts/licence

Checkout Guest Payment Information Management V1

Interface for managing guest payment information

Get

  • Get /V1/guest-carts/{cartId}/payment-information

Post

  • Post /V1/guest-carts/{cartId}/payment-information
  • Post /V1/guest-carts/{cartId}/set-payment-information

Checkout Guest Shipping Information Management V1

Interface for managing guest shipping address information

Post

  • Post /V1/guest-carts/{cartId}/shipping-information

Checkout Guest Totals Information Management V1

Interface for guest quote totals calculation

Post

  • Post /V1/guest-carts/{cartId}/totals-information

Checkout Payment Information Management V1

Interface for managing quote payment information

Get

  • Get /V1/carts/mine/payment-information

Post

  • Post /V1/carts/mine/payment-information
  • Post /V1/carts/mine/set-payment-information

Checkout Shipping Information Management V1

Interface for managing customer shipping address information

Post

  • Post /V1/carts/{cartId}/shipping-information
  • Post /V1/carts/mine/shipping-information

Checkout Totals Information Management V1

Interface for quote totals calculation

Post

  • Post /V1/carts/{cartId}/totals-information
  • Post /V1/carts/mine/totals-information

CMS Block Repository V1

CMS block CRUD interface

Delete

  • Delete /V1/cmsBlock/{blockId}

Get

  • Get /V1/cmsBlock/{blockId}
  • Get /V1/cmsBlock/search

Post

  • Post /V1/cmsBlock

Put

  • Put /V1/cmsBlock/{id}

CMS Page Repository V1

CMS page CRUD interface

Delete

  • Delete /V1/cmsPage/{pageId}

Get

  • Get /V1/cmsPage/{pageId}
  • Get /V1/cmsPage/search

Post

  • Post /V1/cmsPage

Put

  • Put /V1/cmsPage/{id}

Configurable Product Configurable Product Management V1

Interface Configurable Product Management Interface

Put

  • Put /V1/configurable-products/variation

Configurable Product Link Management V1

Manage children products of configurable product

Delete

  • Delete /V1/configurable-products/{sku}/children/{childSku}

Get

  • Get /V1/configurable-products/{sku}/children

Post

  • Post /V1/configurable-products/{sku}/child

Configurable Product Option Repository V1

Manage options of configurable product

Delete

  • Delete /V1/configurable-products/{sku}/options/{id}

Get

  • Get /V1/configurable-products/{sku}/options/{id}
  • Get /V1/configurable-products/{sku}/options/all

Post

  • Post /V1/configurable-products/{sku}/options

Put

  • Put /V1/configurable-products/{sku}/options/{id}

Customer Account Management V1

Interface for managing customers accounts

Get

  • Get /V1/customers/{customerId}/billingAddress
  • Get /V1/customers/{customerId}/confirm
  • Get /V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
  • Get /V1/customers/{customerId}/permissions/readonly
  • Get /V1/customers/{customerId}/shippingAddress
  • Get /V1/customers/me/billingAddress
  • Get /V1/customers/me/shippingAddress

Post

  • Post /V1/customers
  • Post /V1/customers/confirm
  • Post /V1/customers/isEmailAvailable

Put

  • Put /V1/customers/{email}/activate
  • Put /V1/customers/me/activate
  • Put /V1/customers/me/password
  • Put /V1/customers/password
  • Put /V1/customers/validate

Customer Address Metadata V1

Interface for retrieval information about customer address attributes metadata

Get

  • Get /V1/attributeMetadata/customerAddress
  • Get /V1/attributeMetadata/customerAddress/attribute/{attributeCode}
  • Get /V1/attributeMetadata/customerAddress/custom
  • Get /V1/attributeMetadata/customerAddress/form/{formCode}

Customer Address Repository V1

Customer address CRUD interface

Delete

  • Delete /V1/addresses/{addressId}

Get

  • Get /V1/customers/addresses/{addressId}

Customer Balance Balance Management V1

Customer balance(store credit) operations

Post

  • Post /V1/carts/mine/balance/apply

Customer Metadata V1

Interface for retrieval information about customer attributes metadata

Get

  • Get /V1/attributeMetadata/customer
  • Get /V1/attributeMetadata/customer/attribute/{attributeCode}
  • Get /V1/attributeMetadata/customer/custom
  • Get /V1/attributeMetadata/customer/form/{formCode}

Customer Repository V1

Customer CRUD interface

Delete

  • Delete /V1/customers/{customerId}

Get

  • Get /V1/customers/{customerId}
  • Get /V1/customers/me
  • Get /V1/customers/search

Put

  • Put /V1/customers/{id}
  • Put /V1/customers/me

Customer Group Management V1

Interface for managing customer groups

Get

  • Get /V1/customerGroups/{id}/permissions
  • Get /V1/customerGroups/default
  • Get /V1/customerGroups/default/{storeId}

Customer Group Repository V1

Customer group CRUD interface

Delete

  • Delete /V1/customerGroups/{id}

Get

  • Get /V1/customerGroups/{id}
  • Get /V1/customerGroups/search

Post

  • Post /V1/customerGroups

Put

  • Put /V1/customerGroups/{id}

Directory Country Information Acquirer V1

Country information acquirer interface

Get

  • Get /V1/directory/countries
  • Get /V1/directory/countries/{countryId}

Directory Currency Information Acquirer V1

Currency information acquirer interface

Get

  • Get /V1/directory/currency

Downloadable Link Repository V1

Interface Link Repository Interface

Delete

  • Delete /V1/products/downloadable-links/{id}

Get

  • Get /V1/products/{sku}/downloadable-links

Post

  • Post /V1/products/{sku}/downloadable-links

Put

  • Put /V1/products/{sku}/downloadable-links/{id}

Downloadable Sample Repository V1

Interface Sample Repository Interface

Delete

  • Delete /V1/products/downloadable-links/samples/{id}

Get

  • Get /V1/products/{sku}/downloadable-links/samples

Post

  • Post /V1/products/{sku}/downloadable-links/samples

Put

  • Put /V1/products/{sku}/downloadable-links/samples/{id}

eav Attribute Set Management V1

Interface Attribute Set Management Interface

Post

  • Post /V1/eav/attribute-sets

eav Attribute Set Repository V1

Interface Attribute Set Repository Interface

Delete

  • Delete /V1/eav/attribute-sets/{attributeSetId}

Get

  • Get /V1/eav/attribute-sets/{attributeSetId}
  • Get /V1/eav/attribute-sets/list

Put

  • Put /V1/eav/attribute-sets/{attributeSetId}

Gift Card Account Gift Card Account Management V1

Interface Gift Card Account Management Interface

Delete

  • Delete /V1/carts/{quoteId}/giftCards/{giftCardCode}

Get

  • Get /V1/carts/{quoteId}/giftCards
  • Get /V1/carts/mine/checkGiftCard/{giftCardCode}

Post

  • Post /V1/carts/mine/giftCards

Put

  • Put /V1/carts/{cartId}/giftCards

Gift Message Cart Repository V1

Interface Cart Repository Interface

Get

  • Get /V1/carts/{cartId}/gift-message
  • Get /V1/carts/mine/gift-message

Post

  • Post /V1/carts/{cartId}/gift-message
  • Post /V1/carts/mine/gift-message

Gift Message Guest Cart Repository V1

Interface Guest Cart Repository Interface

Get

  • Get /V1/guest-carts/{cartId}/gift-message

Post

  • Post /V1/guest-carts/{cartId}/gift-message

Gift Message Guest Item Repository V1

Interface Guest Item Repository Interface

Get

  • Get /V1/guest-carts/{cartId}/gift-message/{itemId}

Post

  • Post /V1/guest-carts/{cartId}/gift-message/{itemId}

Gift Message Item Repository V1

Interface Item Repository Interface

Get

  • Get /V1/carts/{cartId}/gift-message/{itemId}
  • Get /V1/carts/mine/gift-message/{itemId}

Post

  • Post /V1/carts/{cartId}/gift-message/{itemId}
  • Post /V1/carts/mine/gift-message/{itemId}

Gift Wrapping Wrapping Repository V1

Interface Wrapping Repository Interface

Delete

  • Delete /V1/gift-wrappings/{id}

Get

  • Get /V1/gift-wrappings
  • Get /V1/gift-wrappings/{id}

Post

  • Post /V1/gift-wrappings

Put

  • Put /V1/gift-wrappings/{wrappingId}

Integration Admin Token Service V1

Interface providing token generation for Admins

Post

  • Post /V1/integration/admin/token

Integration Customer Token Service V1

Interface providing token generation for Customers

Post

  • Post /V1/integration/customer/token

Quote Billing Address Management V1

Interface Billing Address Management Interface

Get

  • Get /V1/carts/{cartId}/billing-address
  • Get /V1/carts/mine/billing-address

Post

  • Post /V1/carts/{cartId}/billing-address
  • Post /V1/carts/mine/billing-address

Quote Cart Item Repository V1

Interface Cart Item Repository Interface

Delete

  • Delete /V1/carts/{cartId}/items/{itemId}
  • Delete /V1/carts/mine/items/{itemId}

Get

  • Get /V1/carts/{cartId}/items
  • Get /V1/carts/mine/items

Post

  • Post /V1/carts/{cartId}/items
  • Post /V1/carts/mine/items

Put

  • Put /V1/carts/{cartId}/items/{itemId}
  • Put /V1/carts/mine/items/{itemId}

Quote Cart Management V1

Interface Cart Management Interface

Get

  • Get /V1/carts/mine

Post

  • Post /V1/carts/
  • Post /V1/carts/mine
  • Post /V1/customers/{customerId}/carts

Put

  • Put /V1/carts/{cartId}
  • Put /V1/carts/{cartId}/order
  • Put /V1/carts/mine/order

Quote Cart Repository V1

Interface Cart Repository Interface

Get

  • Get /V1/carts/{cartId}
  • Get /V1/carts/search

Quote Cart Total Management V1

Bundled API to collect totals for cart based on shipping/payment methods and additional data

Put

  • Put /V1/carts/mine/collect-totals

Quote Cart Total Repository V1

Interface Cart Total Repository Interface

Get

  • Get /V1/carts/{cartId}/totals
  • Get /V1/carts/mine/totals

Quote Coupon Management V1

Coupon management service interface

Delete

  • Delete /V1/carts/{cartId}/coupons
  • Delete /V1/carts/mine/coupons

Get

  • Get /V1/carts/{cartId}/coupons
  • Get /V1/carts/mine/coupons

Put

  • Put /V1/carts/{cartId}/coupons/{couponCode}
  • Put /V1/carts/mine/coupons/{couponCode}

Quote Guest Billing Address Management V1

Billing address management interface for guest carts

Get

  • Get /V1/guest-carts/{cartId}/billing-address

Post

  • Post /V1/guest-carts/{cartId}/billing-address

Quote Guest Cart Item Repository V1

Cart Item repository interface for guest carts

Delete

  • Delete /V1/guest-carts/{cartId}/items/{itemId}

Get

  • Get /V1/guest-carts/{cartId}/items

Post

  • Post /V1/guest-carts/{cartId}/items

Put

  • Put /V1/guest-carts/{cartId}/items/{itemId}

Quote Guest Cart Management V1

Cart Management interface for guest carts

Post

  • Post /V1/guest-carts

Put

  • Put /V1/guest-carts/{cartId}
  • Put /V1/guest-carts/{cartId}/order

Quote Guest Cart Repository V1

Cart Repository interface for guest carts

Get

  • Get /V1/guest-carts/{cartId}

Quote Guest Cart Total Management V1

Bundled API to collect totals for cart based on shipping/payment methods and additional data

Put

  • Put /V1/guest-carts/{cartId}/collect-totals

Quote Guest Cart Total Repository V1

Cart totals repository interface for guest carts

Get

  • Get /V1/guest-carts/{cartId}/totals

Quote Guest Coupon Management V1

Coupon management interface for guest carts

Delete

  • Delete /V1/guest-carts/{cartId}/coupons

Get

  • Get /V1/guest-carts/{cartId}/coupons

Put

  • Put /V1/guest-carts/{cartId}/coupons/{couponCode}

Quote Guest Payment Method Management V1

Payment method management interface for guest carts

Get

  • Get /V1/guest-carts/{cartId}/payment-methods
  • Get /V1/guest-carts/{cartId}/selected-payment-method

Put

  • Put /V1/guest-carts/{cartId}/selected-payment-method

Quote Guest Shipment Estimation V1

Interface Guest Shipment Estimation Interface

Post

  • Post /V1/guest-carts/{cartId}/estimate-shipping-methods

Quote Guest Shipping Method Management V1

Shipping method management interface for guest carts

Get

  • Get /V1/guest-carts/{cartId}/shipping-methods

Quote Payment Method Management V1

Interface Payment Method Management Interface

Get

  • Get /V1/carts/{cartId}/payment-methods
  • Get /V1/carts/{cartId}/selected-payment-method
  • Get /V1/carts/mine/payment-methods
  • Get /V1/carts/mine/selected-payment-method

Put

  • Put /V1/carts/{cartId}/selected-payment-method
  • Put /V1/carts/mine/selected-payment-method

Quote Shipment Estimation V1

Interface Shipment Management Interface

Post

  • Post /V1/carts/{cartId}/estimate-shipping-methods
  • Post /V1/carts/mine/estimate-shipping-methods

Quote Shipping Method Management V1

Interface Shipping Method Management Interface

Get

  • Get /V1/carts/{cartId}/shipping-methods
  • Get /V1/carts/mine/shipping-methods

Post

  • Post /V1/carts/{cartId}/estimate-shipping-methods-by-address-id
  • Post /V1/carts/mine/estimate-shipping-methods-by-address-id

Rma Comment Management V1

Interface Comment Repository Interface

Get

  • Get /V1/returns/{id}/comments

Post

  • Post /V1/returns/{id}/comments

Rma Rma Attributes Management V1

Interface Rma Attributes Management Interface

Get

  • Get /V1/returnsAttributeMetadata
  • Get /V1/returnsAttributeMetadata/{attributeCode}
  • Get /V1/returnsAttributeMetadata/custom
  • Get /V1/returnsAttributeMetadata/form/{formCode}

Rma Management V1

Interface Rma Management Interface

Get

  • Get /V1/returns

Post

  • Post /V1/returns

Put

  • Put /V1/returns/{id}

Rma Repository V1

Interface Rma Repository Interface

Delete

  • Delete /V1/returns/{id}

Get

  • Get /V1/returns/{id}

Rma Track Management V1

Interface Track Management Interface

Delete

  • Delete /V1/returns/{id}/tracking-numbers/{trackId}

Get

  • Get /V1/returns/{id}/labels
  • Get /V1/returns/{id}/tracking-numbers

Post

  • Post /V1/returns/{id}/tracking-numbers

Sales Credit memo Comment Repository V1

Credit memo comment repository interface. After a customer places and pays for an order and an invoice has been issued the merchant can create a credit memo to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the customer account so that the customer can make future purchases. A credit memo usually includes comments that detail why the credit memo amount was credited to the customer.

Post

  • Post /V1/creditmemo/{id}/comments

Sales Credit memo Management V1

Credit memo add comment interface. After a customer places and pays for an order and an invoice has been issued the merchant can create a credit memo to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the customer account so that the customer can make future purchases.

Get

  • Get /V1/creditmemo/{id}/comments

Post

  • Post /V1/creditmemo/{id}/emails

Put

  • Put /V1/creditmemo/{id}

Sales Credit memo Repository V1

Credit memo repository interface. After a customer places and pays for an order and an invoice has been issued the merchant can create a credit memo to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the customer account so that the customer can make future purchases.

Get

  • Get /V1/creditmemo
  • Get /V1/creditmemo/{id}
  • Get /V1/creditmemos

Sales Invoice Comment Repository V1

Invoice comment repository interface. An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the invoice history.

Post

  • Post /V1/invoices/comments

Sales Invoice Management V1

Invoice management interface. An invoice is a record of the receipt of payment for an order

Get

  • Get /V1/invoices/{id}/comments

Post

  • Post /V1/invoices/{id}/capture
  • Post /V1/invoices/{id}/emails
  • Post /V1/invoices/{id}/void

Sales Invoice Order V1

Class InvoiceOrderInterface

Post

  • Post /V1/order/{orderId}/invoice

Sales Invoice Repository V1

Invoice repository interface. An invoice is a record of the receipt of payment for an order

Get

  • Get /V1/invoices
  • Get /V1/invoices/{id}

Post

  • Post /V1/invoices/

Sales Order Address Repository V1

Order address repository interface. An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items billing and shipping addresses and shipping and payment methods. A corresponding external document known as a purchase order is emailed to the customer.

Put

  • Put /V1/orders/{parent_id}

Sales Order Item Repository V1

Order item repository interface. An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items billing and shipping addresses and shipping and payment methods. A corresponding external document known as a purchase order is emailed to the customer.

Get

  • Get /V1/orders/items
  • Get /V1/orders/items/{id}

Sales Order Management V1

Order management interface. An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items billing and shipping addresses and shipping and payment methods. A corresponding external document known as a purchase order is emailed to the customer.

Get

  • Get /V1/orders/{id}/comments
  • Get /V1/orders/{id}/statuses

Post

  • Post /V1/orders/{id}/cancel
  • Post /V1/orders/{id}/comments
  • Post /V1/orders/{id}/emails
  • Post /V1/orders/{id}/hold
  • Post /V1/orders/{id}/unhold

Sales Order Repository V1

Order repository interface. An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items billing and shipping addresses and shipping and payment methods. A corresponding external document known as a purchase order is emailed to the customer.

Get

  • Get /V1/orders
  • Get /V1/orders/{id}

Sales Refund Invoice V1

Interface Refund Invoice Interface

Post

  • Post /V1/invoice/{invoiceId}/refund

Sales Refund Order V1

Interface Refund Order Interface

Post

  • Post /V1/order/{orderId}/refund

Sales Rule Coupon Management V1

Coupon management interface

Post

  • Post /V1/coupons/deleteByCodes
  • Post /V1/coupons/deleteByIds
  • Post /V1/coupons/generate

Sales Rule Coupon Repository V1

Coupon CRUD interface

Delete

  • Delete /V1/coupons/{couponId}

Get

  • Get /V1/coupons/{couponId}
  • Get /V1/coupons/search

Post

  • Post /V1/coupons

Put

  • Put /V1/coupons/{couponId}

Sales Rule Rule Repository V1

Sales rule CRUD interface

Delete

  • Delete /V1/salesRules/{ruleId}

Get

  • Get /V1/salesRules/{ruleId}
  • Get /V1/salesRules/search

Post

  • Post /V1/salesRules

Put

  • Put /V1/salesRules/{ruleId}

Sales Shipment Comment Repository V1

Shipment comment repository interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package. A shipment document can contain comments.

Post

  • Post /V1/shipment/{id}/comments

Sales Shipment Management V1

Shipment management interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package.

Get

  • Get /V1/shipment/{id}/comments
  • Get /V1/shipment/{id}/label

Post

  • Post /V1/shipment/{id}/emails

Sales Shipment Repository V1

Shipment repository interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package.

Get

  • Get /V1/shipment/{id}
  • Get /V1/shipments

Post

  • Post /V1/shipment/

Sales Shipment Track Repository V1

Shipment track repository interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package.

Delete

  • Delete /V1/shipment/track/{id}

Post

  • Post /V1/shipment/track

Sales Ship Order V1

Class Ship Order Interface

Post

  • Post /V1/order/{orderId}/ship

Sales Transaction Repository V1

Transaction repository interface. A transaction is an interaction between a merchant and a customer such as a purchase a credit a refund and so on.

Get

  • Get /V1/transactions
  • Get /V1/transactions/{id}

Search V1

Search API for all requests

Get

  • Get /V1/search

Store Group Repository V1

Group repository interface

Get

  • Get /V1/store/storeGroups

Store Config Manager V1

Store config manager interface

Get

  • Get /V1/store/storeConfigs

Store Repository V1

Store repository interface

Get

  • Get /V1/store/storeViews

Store Website Repository V1

Website repository interface

Get

  • Get /V1/store/websites

Tax Class Repository V1

Tax class CRUD interface

Delete

  • Delete /V1/taxClasses/{taxClassId}

Get

  • Get /V1/taxClasses/{taxClassId}
  • Get /V1/taxClasses/search

Post

  • Post /V1/taxClasses

Put

  • Put /V1/taxClasses/{classId}

Tax Rate Repository V1

Tax rate CRUD interface

Delete

  • Delete /V1/taxRates/{rateId}

Get

  • Get /V1/taxRates/{rateId}
  • Get /V1/taxRates/search

Post

  • Post /V1/taxRates

Put

  • Put /V1/taxRates

Tax Rule Repository V1

Tax rule CRUD interface

Delete

  • Delete /V1/taxRules/{ruleId}

Get

  • Get /V1/taxRules/{ruleId}
  • Get /V1/taxRules/search

Post

  • Post /V1/taxRules

Put

  • Put /V1/taxRules
Data Integration & Synchronisation

Data Integration & Synchronisation

Integrate applications, systems and web services via easy-to-use, graphical tools.

Learn more about Data Integration & Synchronisation connectors

Drag and drop experience

A full drag and drop user experience so integration steps are visually represented within a wider automated process.

Transformation functions

A set of transform functions that can be dragged onto the mapping area to change the data between input and output.

Hundreds of connectors

Access hundreds of data connectors via one easy-to-use platform.
View Capability

Got a question?

Send us your questions and we will provide you with the information and resources that you need.

Enquire now

You don’t learn everything in life by reading a manual, sometimes it helps to get in touch

Phone: +44(0) 330 99 88 700