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": [
{
"_id": "<string>",
"ApiVersion": "2026-01-01",
"orderId": "<string>",
"orderAliases": [
{
"aliasId": "<string>",
"aliasType": "SELLER_ORDER_ID"
}
],
"createdTime": "2023-11-07T05:31:56Z",
"lastUpdatedTime": "2023-11-07T05:31:56Z",
"salesChannel": {
"channelName": "AMAZON",
"marketplaceId": "<string>",
"marketplaceName": "<string>"
},
"proceeds": {
"grandTotal": {
"amount": "36.0",
"currencyCode": "<string>"
},
"breakdowns": [
{
"type": "<string>",
"status": "<string>",
"subtotal": {
"amount": "36.0",
"currencyCode": "<string>"
}
}
]
},
"recipient": {
"deliveryAddress": {
"city": "<string>",
"districtOrCounty": "<string>",
"stateOrRegion": "<string>",
"municipality": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"addressType": "RESIDENTIAL"
},
"deliveryPreference": {
"dropOffLocation": "<string>",
"addressInstruction": "<string>",
"deliveryTime": {
"businessHours": [
{
"dayOfWeek": "SUN",
"timeWindows": [
{
"startTime": {
"hour": 123,
"minute": 123
},
"endTime": {
"hour": 123,
"minute": 123
}
}
]
}
],
"exceptionDates": [
{
"exceptionDate": "2023-12-25",
"exceptionDateType": "CLOSED",
"timeWindows": [
{
"startTime": {
"hour": 123,
"minute": 123
},
"endTime": {
"hour": 123,
"minute": 123
}
}
]
}
]
},
"deliveryCapabilities": [
"HAS_ACCESS_POINT"
]
}
},
"fulfillment": {
"fulfillmentStatus": "PENDING_AVAILABILITY",
"fulfilledBy": "AMAZON",
"fulfillmentServiceLevel": "EXPEDITED",
"shipByWindow": {
"earliestDateTime": "2023-11-07T05:31:56Z",
"latestDateTime": "2023-11-07T05:31:56Z"
},
"deliverByWindow": {
"earliestDateTime": "2023-11-07T05:31:56Z",
"latestDateTime": "2023-11-07T05:31:56Z"
},
"labelPrintingWindow": {
"earliestDateTime": "2023-11-07T05:31:56Z",
"latestDateTime": "2023-11-07T05:31:56Z"
},
"promiseCalculationInputs": {
"transitTime": {
"details": {
"carrier": "<string>",
"shippingService": "<string>"
},
"dataSource": "AMAZON_AUTOMATED"
}
}
},
"programs": [
"PREORDER"
],
"associatedOrders": [
{
"orderId": "<string>",
"associationType": "REPLACEMENT_ORIGINAL_ID"
}
],
"packages": [
{
"packageReferenceId": "<string>",
"createdTime": "2023-11-07T05:31:56Z",
"packageStatus": {
"status": "PENDING",
"detailedStatus": "PENDING_SCHEDULE"
},
"carrier": "<string>",
"shipTime": "2023-11-07T05:31:56Z",
"shippingService": "<string>",
"trackingNumber": "<string>",
"shipFromAddress": {
"name": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"addressLine3": "<string>",
"city": "<string>",
"districtOrCounty": "<string>",
"stateOrRegion": "<string>",
"municipality": "<string>",
"postalCode": "<string>",
"countryCode": "<string>"
},
"packageItems": [
{
"orderItemId": "<string>",
"quantity": 123,
"transparencyCodes": [
"<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": [
{
"_id": "<string>",
"ApiVersion": "2026-01-01",
"orderId": "<string>",
"orderAliases": [
{
"aliasId": "<string>",
"aliasType": "SELLER_ORDER_ID"
}
],
"createdTime": "2023-11-07T05:31:56Z",
"lastUpdatedTime": "2023-11-07T05:31:56Z",
"salesChannel": {
"channelName": "AMAZON",
"marketplaceId": "<string>",
"marketplaceName": "<string>"
},
"proceeds": {
"grandTotal": {
"amount": "36.0",
"currencyCode": "<string>"
},
"breakdowns": [
{
"type": "<string>",
"status": "<string>",
"subtotal": {
"amount": "36.0",
"currencyCode": "<string>"
}
}
]
},
"recipient": {
"deliveryAddress": {
"city": "<string>",
"districtOrCounty": "<string>",
"stateOrRegion": "<string>",
"municipality": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"addressType": "RESIDENTIAL"
},
"deliveryPreference": {
"dropOffLocation": "<string>",
"addressInstruction": "<string>",
"deliveryTime": {
"businessHours": [
{
"dayOfWeek": "SUN",
"timeWindows": [
{
"startTime": {
"hour": 123,
"minute": 123
},
"endTime": {
"hour": 123,
"minute": 123
}
}
]
}
],
"exceptionDates": [
{
"exceptionDate": "2023-12-25",
"exceptionDateType": "CLOSED",
"timeWindows": [
{
"startTime": {
"hour": 123,
"minute": 123
},
"endTime": {
"hour": 123,
"minute": 123
}
}
]
}
]
},
"deliveryCapabilities": [
"HAS_ACCESS_POINT"
]
}
},
"fulfillment": {
"fulfillmentStatus": "PENDING_AVAILABILITY",
"fulfilledBy": "AMAZON",
"fulfillmentServiceLevel": "EXPEDITED",
"shipByWindow": {
"earliestDateTime": "2023-11-07T05:31:56Z",
"latestDateTime": "2023-11-07T05:31:56Z"
},
"deliverByWindow": {
"earliestDateTime": "2023-11-07T05:31:56Z",
"latestDateTime": "2023-11-07T05:31:56Z"
},
"labelPrintingWindow": {
"earliestDateTime": "2023-11-07T05:31:56Z",
"latestDateTime": "2023-11-07T05:31:56Z"
},
"promiseCalculationInputs": {
"transitTime": {
"details": {
"carrier": "<string>",
"shippingService": "<string>"
},
"dataSource": "AMAZON_AUTOMATED"
}
}
},
"programs": [
"PREORDER"
],
"associatedOrders": [
{
"orderId": "<string>",
"associationType": "REPLACEMENT_ORIGINAL_ID"
}
],
"packages": [
{
"packageReferenceId": "<string>",
"createdTime": "2023-11-07T05:31:56Z",
"packageStatus": {
"status": "PENDING",
"detailedStatus": "PENDING_SCHEDULE"
},
"carrier": "<string>",
"shipTime": "2023-11-07T05:31:56Z",
"shippingService": "<string>",
"trackingNumber": "<string>",
"shipFromAddress": {
"name": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"addressLine3": "<string>",
"city": "<string>",
"districtOrCounty": "<string>",
"stateOrRegion": "<string>",
"municipality": "<string>",
"postalCode": "<string>",
"countryCode": "<string>"
},
"packageItems": [
{
"orderItemId": "<string>",
"quantity": 123,
"transparencyCodes": [
"<string>"
]
}
]
}
]
}
]
}Body
application/json
Filter criteria
Was this page helpful?