Skip to main content
POST
/
orders
/
amazon
Retrieve a list of orders for an Amazon channel (Requires Enterprise plan)
curl --request POST \
  --url https://mm-api.merchantspring.io/orders/amazon \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "channelId": "<string>",
  "merchantId": "<string>",
  "fromDate": "1609459200",
  "toDate": "1612137600",
  "orderId": "<string>",
  "key": "<string>",
  "pageSize": "50"
}
'
{
  "meta": {
    "key": "<string>"
  },
  "data": [
    {
      "SellerId": "<string>",
      "MarketplaceId": "<string>",
      "BuyerInfo": {
        "BuyerEmail": "<string>"
      },
      "AmazonOrderId": "<string>",
      "FulfillmentChannel": "<string>",
      "EarliestDeliveryDate": "<string>",
      "EarliestShipDate": "<string>",
      "SalesChannel": "<string>",
      "AutomatedShippingSettings": {
        "HasAutomatedShippingSettings": "<string>",
        "AutomatedShipMethodName": "<string>",
        "AutomatedCarrierName": "<string>"
      },
      "OrderStatus": "<string>",
      "NumberOfItemsShipped": 123,
      "NumberOfItemsUnshipped": 123,
      "OrderType": "<string>",
      "IsPremiumOrder": true,
      "IsPrime": true,
      "HasRegulatedItems": true,
      "IsReplacementOrder": true,
      "IsSoldByAB": true,
      "LatestShipDate": "<string>",
      "ShipServiceLevel": "<string>",
      "DefaultShipFromLocationAddress": {
        "StateOrRegion": "<string>",
        "PostalCode": "<string>",
        "City": "<string>",
        "CountryCode": "<string>"
      },
      "IsISPU": true,
      "LatestDeliveryDate": "<string>",
      "PurchaseDate": "<string>",
      "ShippingAddress": {
        "StateOrRegion": "<string>",
        "PostalCode": "<string>",
        "City": "<string>",
        "CountryCode": "<string>"
      },
      "IsAccessPointOrder": true,
      "PaymentMethod": "<string>",
      "IsBusinessOrder": true,
      "OrderTotal": {
        "Amount": 123,
        "CurrencyCode": "<string>"
      },
      "PaymentMethodDetails": "<string>",
      "IsGlobalExpressEnabled": true,
      "LastUpdateDate": "<string>",
      "ShipmentServiceLevelCategory": "<string>"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Body

application/json

Filter criteria

channelId
string
merchantId
string
dateField
enum<string>

(Optional) The field to which fromDate and toDate filter are applied - either 'createdAt' or 'updatedAt'

Available options:
createdAt,
updatedAt
fromDate
number

(Optional) Unix epoch time (seconds) representing the start of the reporting period

Example:

"1609459200"

toDate
number

(Optional) Unix epoch time (seconds) representing the end of the reporting period

Example:

"1612137600"

orderId
string

(Optional) The order ID to filter by

key
string

(Optional) The key used for pagination

pageSize
number

(Optional) The number of results to return per page (Max 100)

Example:

"50"

Response

Successful operation

meta
object
data
object[]