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
}
'import requests
url = "https://mm-api.merchantspring.io/orders/amazon"
payload = {
"channelId": "<string>",
"merchantId": "<string>",
"fromDate": 1609459200,
"toDate": 1612137600,
"orderId": "<string>",
"key": "<string>",
"pageSize": 50
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
channelId: '<string>',
merchantId: '<string>',
fromDate: 1609459200,
toDate: 1612137600,
orderId: '<string>',
key: '<string>',
pageSize: 50
})
};
fetch('https://mm-api.merchantspring.io/orders/amazon', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://mm-api.merchantspring.io/orders/amazon",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'channelId' => '<string>',
'merchantId' => '<string>',
'fromDate' => 1609459200,
'toDate' => 1612137600,
'orderId' => '<string>',
'key' => '<string>',
'pageSize' => 50
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://mm-api.merchantspring.io/orders/amazon"
payload := strings.NewReader("{\n \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"fromDate\": 1609459200,\n \"toDate\": 1612137600,\n \"orderId\": \"<string>\",\n \"key\": \"<string>\",\n \"pageSize\": 50\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://mm-api.merchantspring.io/orders/amazon")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"fromDate\": 1609459200,\n \"toDate\": 1612137600,\n \"orderId\": \"<string>\",\n \"key\": \"<string>\",\n \"pageSize\": 50\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mm-api.merchantspring.io/orders/amazon")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"fromDate\": 1609459200,\n \"toDate\": 1612137600,\n \"orderId\": \"<string>\",\n \"key\": \"<string>\",\n \"pageSize\": 50\n}"
response = http.request(request)
puts response.read_body{
"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>"
}
]
}
Order
Retrieve a list of orders for an Amazon channel (Requires Enterprise plan)
Retrieve a list of orders for an Amazon channel that match the specified filter criteria.
NOTE: This endpoint is only available to users on the Enterprise plan.
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
}
'import requests
url = "https://mm-api.merchantspring.io/orders/amazon"
payload = {
"channelId": "<string>",
"merchantId": "<string>",
"fromDate": 1609459200,
"toDate": 1612137600,
"orderId": "<string>",
"key": "<string>",
"pageSize": 50
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
channelId: '<string>',
merchantId: '<string>',
fromDate: 1609459200,
toDate: 1612137600,
orderId: '<string>',
key: '<string>',
pageSize: 50
})
};
fetch('https://mm-api.merchantspring.io/orders/amazon', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://mm-api.merchantspring.io/orders/amazon",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'channelId' => '<string>',
'merchantId' => '<string>',
'fromDate' => 1609459200,
'toDate' => 1612137600,
'orderId' => '<string>',
'key' => '<string>',
'pageSize' => 50
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://mm-api.merchantspring.io/orders/amazon"
payload := strings.NewReader("{\n \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"fromDate\": 1609459200,\n \"toDate\": 1612137600,\n \"orderId\": \"<string>\",\n \"key\": \"<string>\",\n \"pageSize\": 50\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://mm-api.merchantspring.io/orders/amazon")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"fromDate\": 1609459200,\n \"toDate\": 1612137600,\n \"orderId\": \"<string>\",\n \"key\": \"<string>\",\n \"pageSize\": 50\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mm-api.merchantspring.io/orders/amazon")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"channelId\": \"<string>\",\n \"merchantId\": \"<string>\",\n \"fromDate\": 1609459200,\n \"toDate\": 1612137600,\n \"orderId\": \"<string>\",\n \"key\": \"<string>\",\n \"pageSize\": 50\n}"
response = http.request(request)
puts response.read_body{
"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
Body
application/json
Filter criteria
The field to which fromDate and toDate filter are applied - either 'createdAt' or 'updatedAt'
Available options:
createdAt, updatedAt Start of date range as unix epoch seconds.
Example:
1609459200
End of date range as unix epoch seconds.
Example:
1612137600
The order ID to filter by
The key used for pagination
The number of results to return per page (Max 100)
Example:
50
Was this page helpful?