AS2
AS2 Sender Controller
| API | Description |
|---|---|
| POST api/as2/sender |
send EDI or other messages over HTTP/S, using the AS2 protocol. |
| POST api/as2/receive |
process EDI messages and generate receipts. |
| POST api/as2/upload/key |
No documentation available. |
| POST api/as2/upload/cert |
No documentation available. |
Coupa
Coupa Controller
| API | Description |
|---|---|
| GET api/coupa/attachments/{attachmentId} |
Gets a file attachment by attachment id |
CyberSource
Coupa Controller
| API | Description |
|---|---|
| POST api/cybersource/{id}/reversals |
You can use the authorization reversal service to reverse an unnecessary or undesired authorization. |
Excel
| API | Description |
|---|---|
| POST api/excel |
Excel Merge request and returns File Content in Base64 string |
Ftp
File Transfer Protocol (FTP) Controller
| API | Description |
|---|---|
| GET api/ftp?remoteFile={remoteFile}&extended={extended} |
List the current or extended directory information specified by RemotePath on an FTP server. (for extended=true) This method is used to request a directory (or file mask) listing specified in RemoteFile. RemoteFile is either an absolute path on the server, or a path relative to RemotePath. Note that since RemoteFile acts as a file mask, to retrieve a complete directory listing RemoteFile should be set to empty string or a mask like "*". |
| GET api/v2/ftp?remoteFile={remoteFile}&extended={extended} |
List the current or extended directory information specified by RemotePath on an FTP server. (for extended=true) This method is used to request a directory (or file mask) listing specified in RemoteFile. RemoteFile is either an absolute path on the server, or a path relative to RemotePath. Note that since RemoteFile acts as a file mask, to retrieve a complete directory listing RemoteFile should be set to empty string or a mask like "*". |
| DELETE api/ftp/delete?fileName={fileName} |
Removes a file specified by the request from an FTP server. |
| DELETE api/v2/ftp/delete?fileName={fileName} |
Removes a file specified by the request from an FTP server. |
| DELETE api/ftp |
Removes a file specified by the request from an FTP server. |
| DELETE api/v2/ftp |
Removes a file specified by the request from an FTP server. |
| POST api/ftp/rename |
renames a file specified by the request to an FTP server. |
| POST api/v2/ftp/rename |
renames a file specified by the request to an FTP server. |
| PUT api/ftp |
Upload a file specified by the request to an FTP server. |
| PUT api/v2/ftp |
Upload a file specified by the request to an FTP server. |
| POST api/ftp |
downloads a file specified by the request to an FTP server. |
| POST api/v2/ftp |
downloads a file specified by the request to an FTP server. |
| POST api/ftp/dir |
Create a directory on an FTP server. This method is used to create a directory with path specified by NewDir on the FTP server. NewDir is either an absolute path on the server, or a path relative to RemotePath. |
| POST api/v2/ftp/dir |
Create a directory on an FTP server. This method is used to create a directory with path specified by NewDir on the FTP server. NewDir is either an absolute path on the server, or a path relative to RemotePath. |
| DELETE api/ftp/dir |
No documentation available. |
| DELETE api/v2/ftp/dir |
No documentation available. |
Catalog
Catalog Controller
| API | Description |
|---|---|
| GET api/magento/catalog/products?fd={fd}&op={op}&v={v} |
Gets product list |
| GET api/magento/catalog/products/{sku} |
Gets a product by sku |
| GET api/magento/catalog/products/stocklist |
Gets products inventory stock information |
| POST api/magento/catalog/products |
Creates a product |
| PUT api/magento/catalog/products/{sku}/update |
Updates a product |
| DELETE api/magento/catalog/products/{sku} |
Delete a product |
| PUT api/magento/catalog/products/{sku}/stockupdate |
Updates a product inventory stock |
Credit
Credit Memo Controller
| API | Description |
|---|---|
| GET api/magento/credits/{creditmemoId} |
Gets a credit memo by id |
Customer
Customer Controller
| API | Description |
|---|---|
| GET api/magento/customers?fd={fd}&op={op}&v={v} |
Gets customer list |
| GET api/magento/customers/{customerId} |
Gets a customer by id |
| GET api/magento/customers/{customerId}/addresses |
Gets customer address list |
Invoice
Invoice Controller
| API | Description |
|---|---|
| GET api/magento/invoices/{invoiceId} |
Gets an invoice by id |
Order
Sales order Controller
| API | Description |
|---|---|
| GET api/magento/orders?fd={fd}&op={op}&v={v} |
Gets order list |
| GET api/magento/orders/{orderId} |
Gets order by order id |
| POST api/magento/orders/{orderId}/cancel |
Cancels order |
| POST api/magento/orders/{orderId}/bill |
Bills order (creates invoice and captures fund) |
| POST api/magento/orders/{orderId}/ship |
Ships order (creates a new shipment and adds shipping tracking numbers) |
| POST api/magento/orders/{orderId}/credit |
Issues a credit against the order (creates a credit memo) |
Shipment
Shipment Controller
| API | Description |
|---|---|
| GET api/magento/shipments/{shipmentId} |
Gets an order shipment by id |
Merge
| API | Description |
|---|---|
| POST api/merge |
Merge request and returns File Content in Base64 string |
AmzFeed
Amazon Feed Controller The Amazon MWS Feeds API section of the Amazon Marketplace Web Service (Amazon MWS) API lets you upload inventory and order data to Amazon. You can also use the Amazon MWS Feeds API section to get information about the processing of feeds.
| API | Description |
|---|---|
| POST api/mws/feed/submit |
Uploads a feed for processing by Amazon MWS. Feed size is limited to 2 GB (231-1, or 2,147,483,647 bytes) per feed. If you have a large amount of data to submit, you should submit feeds smaller than the feed size limit by breaking up the data, or submit the feeds over a period of time. For optimal performance, a good practice is to submit feeds with a size limit of 30,000 records/items, or submit feeds over a period of time, such as every few hours. Availability - This operation is available in all marketplaces. Throttling Maximum request: quota 15 requests. Restore rate: One request every two minutes. Hourly request quota: 30 requests per hour |
AmzOrder
Amazon Sales order Controller You can retrieve order item information by first using the ListOrders operation to find orders created or updated during a time frame that you specify. An AmazonOrderId is included with each order that is returned. You can then use these AmazonOrderId values with the ListOrderItems operation to get detailed order item information for each order.
| API | Description |
|---|---|
| POST api/mws/orders/ListOrders |
Returns a list of orders created or updated during a time frame that you specify. You define that time frame using the CreatedAfter parameter or the LastUpdatedAfter parameter. You must use one of these parameters, but not both. You can also apply a range of filtering criteria to narrow the list of orders that is returned. Availability - This operation is available in all marketplaces. Throttling - The ListOrders and ListOrdersByNextToken operations together share a maximum request quota of six and a restore rate of one request every minute. |
| POST api/mws/orders/ListOrdersByNextToken |
Returns the next page of orders using the NextToken parameter. The ListOrdersByNextToken operation returns the next page of orders using the NextToken value that was returned by your previous request to either ListOrders or ListOrdersByNextToken. If NextToken is not returned, there are no more pages to return. Availability - This operation is available in all marketplaces. Throttling - The ListOrders and ListOrdersByNextToken operations together share a maximum request quota of six and a restore rate of one request every minute. |
| POST api/mws/orders/GetOrder |
Returns orders based on the AmazonOrderId values that you specify. The GetOrder operation returns an order for each AmazonOrderId that you specify, up to a maximum of 50. The GetOrder operation includes order information for each order returned, including PurchaseDate, OrderStatus, FulfillmentChannel, and LastUpdateDate. Availability - This operation is available in all marketplaces. Throttling - The GetOrder operation has a maximum request quota of six and a restore rate of one request every minute. |
| POST api/mws/orders/ListOrderItems |
Returns order items based on the AmazonOrderId that you specify. The ListOrderItems operation returns order item information for an AmazonOrderId that you specify. The order item information includes Title, ASIN, SellerSKU, ItemPrice, ShippingPrice, as well as tax and promotion information. you can retrieve order item information by first using the ListOrders operation to find orders created or updated during a time frame that you specify. An AmazonOrderId is included with each order that is returned. You can then use these AmazonOrderId values with the ListOrderItems operation to get detailed order item information for each order. Note: When an order is in the Pending state (the order has been placed but payment has not been authorized), the ListOrderItems operation does not return information about pricing, taxes, shipping charges, gift wrapping, or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the ListOrderItems operation returns information about pricing, taxes, shipping charges, gift wrapping, and promotions for the order items in the order. Availability - This operation is available in all marketplaces. Throttling - The ListOrderItems and ListOrderItemsByNextToken operations together share a maximum request quota of 30 and a restore rate of one request every two seconds. |
| POST api/mws/orders/ListOrderItemsByNextToken |
Returns the next page of order items using the NextToken parameter. The ListOrderItemsByNextToken operation returns the next page of order items using the NextToken value that was returned by your previous request to either ListOrderItems or ListOrderItemsByNextToken. If NextToken is not returned, there are no more pages to return. Availability - This operation is available in all marketplaces. Throttling - The ListOrderItems and ListOrderItemsByNextToken operations together share a maximum request quota of 30 and a restore rate of one request every two seconds. |
| POST api/mws/orders/OrderAcknowledgement |
The Order Acknowledgment feed allows you to acknowledge your success or failure with downloading an order. The acknowledgment feed also allows you to provide your own order ID and order item IDs, which you can then reference in future feeds for the same order, if desired. Additionally, you can use this feed to cancel the entire order under one of these circumstances: The customer asked you to cancel the order (and you have not yet shipped it) You received a single-item order but you can't ship the item (damaged goods) You are unable to upload an order into your system To cancel the order, use the "Failure" StatusCode. Notes: Do not issue an Order Acknowledgment request with the "Failure" StatusCode after at least one item in the order has been confirmed as shipped (see the next section: OrderFulfillment). This would refund the entire order amount to the buyer. For all CancelReason values except NoInventory, Amazon will increase the item’s stock level by the count of canceled units. Availability - This operation is available in all marketplaces. Throttling Maximum request quota - 15 requests Restore rate - One request every two minutes Hourly request quota - 30 requests per hour |
| POST api/mws/orders/OrderFulfillment |
The Order Fulfillment feed allows your system to update Amazon's system with order fulfillment information. Amazon posts the information in the customer's Amazon account so the customer can check the shipment status. Once you've shipped the order, send Amazon a shipping confirmation with fulfillment information. If you shipped the order using a trackable shipping method, include the tracking number in the feed. Amazon provides standard shipper codes (CarrierCode) as well as free-text fields so you can enter a different shipper. Availability - This operation is available in all marketplaces. Throttling Maximum request quota - 15 requests Restore rate - One request every two minutes Hourly request quota - 30 requests per hour |
| POST api/mws/orders/OrderAdjustment |
The Order Adjustment feed allows you to issue a refund (adjustment) for an order. You must provide a reason for the adjustment, such as "Customer Return," and the adjustment amount, broken out by price component (principle, shipping, tax, and so on). Note, however, that the buyer's credit card will only be credited one time for the total amount. Although the adjustment feed allows for charging the buyer additional money (for a restocking fee, for example), the net amount of the adjustment must be a credit to the buyer. Additionally, you can use the Order Adjustment feed to cancel individual items that you are unable to ship, without incurring a refund holdback fee. To use this feature, you must provide an adjustment reason of NoInventory or BuyerCancelled, and the quantity of items being cancelled. Note: To cancel an entire order, use the Order Acknowledgement not the Order Adjustment. Availability - This operation is available in all marketplaces. Throttling Maximum request quota - 15 requests Restore rate - One request every two minutes Hourly request quota - 30 requests per hour |
| GET api/mws/orders/GetServiceStatus |
Returns the operational status of the Orders API service. The GetServiceStatus operation returns the operational status of the Orders API section of Amazon Marketplace Web Service. Status values are GREEN, YELLOW, and RED. Throttling - The GetServiceStatus operation has a maximum request quota of two and a restore rate of one request every five minutes. |
AmzShipment
Amazon Shipment / Merchant Fulfillment Controller Before a seller can use any application that uses the Merchant Fulfillment service to fulfill Prime orders, they need to: 1.Review and accept the terms and conditions of the Buy Shipping Services program. 2.Review and accept the terms and conditions of any carrier that they want to purchase shipping from. Sellers can review and accept terms and conditions on the Manage Shipping Services page of Seller Central. Calling the Merchant Fulfillment service on behalf of a seller who has not accepted the terms and conditions of Amazon and the carrier returns the TermsAndConditionsNotAccepted error.
| API | Description |
|---|---|
| POST api/mws/shipment/GetEligibleShippingServices |
Returns a list of shipping service offers. The GetEligibleShippingServices operation returns a list of shipping service offers that satisfy the shipment request details that you specify. Use this operation to find a shipping service offer that meets your requirements, then specify the ShippingServiceId value and the optional ShippingServiceOfferId value associated with this shipping service offer in a subsequent call to the CreateShipment operation. Availability - This operation is only available in the Mexico, US, Germany, and UK marketplaces. Throttling - This operation has a maximum request quota of 10 and a restore rate of five requests every second. |
| POST api/mws/shipment/CreateShipment |
The CreateShipment operation purchases shipping and returns PDF, PNG, or ZPL document data for a shipping label, depending on the carrier. Amazon compresses the document data before returning it as a Base64-encoded string. The CreateShipment operation also returns a Base64-encoded MD5 hash to validate the document data. Important: The CreateShipment operation returns a ShipmentId value. Be sure to store this value for future use, as it is a required request parameter for the GetShipment and CancelShipment operations. Availability - This operation is only available in the Mexico, US, Germany, and UK marketplaces. Throttling - This operation has a maximum request quota of 10 and a restore rate of five requests every second. |
| POST api/mws/shipment/GetShipment |
Returns an existing shipment for a given identifier. The GetShipment operation returns an existing shipment for the ShipmentId value that you specify. You can use this operation to get document data for shipping labels in case the label document data originally returned by the CreateShipment operation is lost. For limitations on getting new shipping labels, see "Reprint a Shipping Label" on Seller Central. Get the ShipmentId value from a previous call to the CreateShipment operation. Availability - This operation is only available in the Mexico, US, Germany, and UK marketplaces. Throttling - This operation has a maximum request quota of 10 and a restore rate of five requests every second. |
| POST api/mws/shipment/CancelShipment |
Cancels an existing shipment. The CancelShipment operation cancels an existing shipment and requests a refund for the ShipmentId value that you specify. Get the ShipmentId value from a previous call to the CreateShipment operation. Canceling a shipment only succeeds if the cancellation window has not expired and if the shipment has not previously been canceled. Cancellation policies vary by carrier. For more information about carrier cancellation policies, see the Seller Central Help Creating new shipments after canceling These are conditions where you can create new shipments after canceling existing shipments: If only a single shipment was created to fulfill an order, you can cancel the shipment and then create a new shipment for that order using the CancelShipment operation. If multiple shipments were created to fulfill an order, you can cancel the shipments, but cannot create new shipments using the Merchant Fulfillment service. You will need to either create new shipments in Seller Central or arrange for shipping by contacting a carrier directly. Availability - This operation is only available in the Mexico, US, Germany, and UK marketplaces. Throttling - This operation has a maximum request quota of 10 and a restore rate of five requests every second. |
| POST api/mws/shipment/ExtractLabel |
Returns the label content in a Base64-encoded string. |
| GET api/mws/shipment/GetServiceStatus |
Returns the operational status of the Merchant Fulfillment service. The GetServiceStatus operation returns the operational status of the Merchant Fulfillment service of Amazon Marketplace Web Service. Status values are GREEN, YELLOW, and RED. Throttling - The GetServiceStatus operation has a maximum request quota of two and a restore rate of one request every five minutes. |
SFtp
SSH File Transfer Protocol (SFTP) Controller
| API | Description |
|---|---|
| GET api/sftp?remoteFile={remoteFile} |
List the current or extended directory information specified by RemotePath on an SFTP server. This method is used to request a directory (or file mask) listing specified in RemoteFile. RemoteFile is either an absolute path on the server, or a path relative to RemotePath. Note that since RemoteFile acts as a file mask, to retrieve a complete directory listing RemoteFile should be set to empty string or a mask like "*". |
| DELETE api/sftp/delete?fileName={fileName} |
Removes a file specified by the request from an SFTP server. |
| DELETE api/sftp |
Removes a file specified by the request from an SFTP server. |
| POST api/sftp/rename |
renames a file specified by the request to an SFTP server. |
| PUT api/sftp |
Upload a file specified by the request to an SFTP server. |
| POST api/sftp |
downloads a file specified by the request to an SFTP server. |
| POST api/sftp/dir |
Create a directory on an SFTP server. This method is used to create a directory with path specified by NewDir on the SFTP server. NewDir is either an absolute path on the server, or a path relative to RemotePath. |
| DELETE api/sftp/dir |
No documentation available. |
SFtpSsh
SSH File Transfer Protocol (SFTP) Controller
| API | Description |
|---|---|
| GET api/v2/sftp?remoteFile={remoteFile} |
List the current or extended directory information specified by RemotePath on an SFTP server. This method is used to request a directory (or file mask) listing specified in RemoteFile. RemoteFile is either an absolute path on the server, or a path relative to RemotePath. Note that since RemoteFile acts as a file mask, to retrieve a complete directory listing RemoteFile should be set to empty string or a mask like "*". |
| DELETE api/v2/sftp/delete?fileName={fileName} |
Removes a file specified by the request from an SFTP server. |
| DELETE api/v2/sftp |
Removes a file specified by the request from an SFTP server. |
| POST api/v2/sftp/rename |
renames a file specified by the request to an SFTP server. |
| PUT api/v2/sftp |
Upload a file specified by the request to an SFTP server. |
| POST api/v2/sftp |
downloads a file specified by the request to an SFTP server. |
| POST api/v2/sftp/dir |
Create a directory on an SFTP server. This method is used to create a directory with path specified by NewDir on the SFTP server. NewDir is either an absolute path on the server, or a path relative to RemotePath. |
| DELETE api/v2/sftp/dir |
No documentation available. |
Zip
Zip Controller
| API | Description |
|---|---|
| POST api/zip/compress |
compressing request and returns compressed file Content in Base64 string |
| POST api/zip/decompress |
decompressing request and returns File(s) Content in Base64 string |