Order API
Schema
input AppCredentialsInput {
appId: ID!
appSecret: String!
}
input InstanceInput {
clientId: String!
platform: Platform!
}
enum Platform {
AMAZON
}
enum OrderStatus {
NEW
ACCEPTED
LABELING
AWAITING
FULFILLING
CONFIRMED
CANCELLED
DELETED
SYNCING
INVOICED
}
type Order {
id: ID!
orderId: String!
instance: String!
status: OrderStatus!
warehouseId: String!
customerOrderNumber: String!
shippingAddress: ShippingAddress!
orderDate: AWSDateTime!
requiredShipDate: AWSDateTime!
vendorCode: String
promisedDeliveryDate: AWSDateTime
isPriorityShipment: Boolean
isPslipRequired: Boolean
totalAmount: Float!
orderItems: [OrderItem!]!
packages: [OrderPackage]!
owner: String!
fulfillment: FulfillmentO
acknowledgmentStatus: AcknowledgmentStatus
statusTemp: OrderStatus
labelFormat: String
isGift: Boolean
missAsin: [String]
getLabels: String
skus: String
shipMethods: String
singleLabel: Boolean
createdAt: AWSDateTime!
updatedAt: AWSDateTime!
expiredAt: AWSTimestamp!
methodCode: String
originalCarrier: String
shipFrom: ShippingAddress
transationId: String
ltl: Boolean
}
type OrderItem {
itemNumber: Int!
productName: String!
sku: String!
asin: String!
quantity: Int!
quantityUnit: String!
totalCost: Float!
totalPrice: Float
currency: String
giftMessage: String
description: String
weightUnit: WeightUnit
dimUnit: LengthUnit
weight: Float
length: Float
width: Float
height: Float
boxes: Int
singleLabel: Boolean
lineNumbers: [String]
cartons: String
itemsPerPackage: Int
}
type ShippingAddress {
city: String
stateOrRegion: String
postalCode: String
countryCode: String
addressType: String
}
enum LengthUnit {
CM ##Centimeter
IN ##Inch
}
enum WeightUnit {
LB ## Pound
KG ## Kg
}
type OrderPackage @aws_iam @aws_cognito_user_pools {
packageId: String!
itemNumbers: [String]!
boxNumber: Int!
trackingId: String
shipMethod: String
shipMethodName: String
}
TIP
You can find the clientId for InstanceInput from the instances page > click the instance name. AWSDateTime in ISO 8601 format, example: 2021-08-24T22:23:49Z.
The orders will contain more and more information as you accept, request label, get label, add to fulfillment and confirm them.
API
Batch Order Query
1. Definition
Request the details of orders in a batch
2.Request Method
POST
3.Request Header
x-api-key:<Check with the support for API key>
GraphQL QUERY
query PublicApiOrders(
$credentials: AppCredentialsInput!
$instance: InstanceInput!
$after: AWSDateTime!
$before: AWSDateTime!
$status: OrderStatus!
$limit: Int
$nextToken: String
) {
publicApiOrders(
credentials: $credentials
instance: $instance
after: $after
before: $before
status: $status
limit: $limit
nextToken: $nextToken
) {
orders {
id
orderId
instance
status
warehouseId
customerOrderNumber
shippingAddress {
city
stateOrRegion
postalCode
countryCode
addressType
}
orderDate
requiredShipDate
vendorCode
promisedDeliveryDate
isPriorityShipment
isPslipRequired
totalAmount
orderItems {
itemNumber
productName
sku
asin
quantity
quantityUnit
totalCost
totalPrice
currency
giftMessage
description
weightUnit
dimUnit
weight
length
width
height
boxes
singleLabel
lineNumbers
cartons
itemsPerPackage
}
packages {
packageId
itemNumbers
boxNumber
trackingId
shipMethod
shipMethodName
}
owner
fulfillment {
name
createdAt
}
acknowledgmentStatus {
code
description
}
statusTemp
labelFormat
isGift
missAsin
getLabels
skus
shipMethods
singleLabel
createdAt
updatedAt
expiredAt
methodCode
originalCarrier
shipFrom {
name
addressLine1
addressLine2
addressLine3
city
stateOrRegion
postalCode
countryCode
phoneNumber
addressType
}
transationId
ltl
version
}
nextToken
}
}
GraphQL VARIABLES
{
{
"credentials": {
"appId": "<Request the appId from support>",
"appSecret": "<Request the appSecret from support>"
},
"instance": {
"clientId": "123123",
"platform": "AMAZON"
},
"limit": 5,
"after": "2021-08-01T00:00:00Z",
"before": "2021-08-31T00:00:00Z",
"status": "NEW"
}
}
RESPONSE
{
"data": {
"publicApiOrders": {
"orders": [
{
"id": "e3806090-0ac1-11ec-acf4-410d01a7d4ff",
"orderId": "iXeRoCsEO",
"instance": "AMAZON#123123123",
"status": "NEW",
"warehouseId": "KLOP",
"customerOrderNumber": "307-16087885-18469020",
"shippingAddress": {
"city": "Idaho Falls",
"stateOrRegion": "ID",
"postalCode": "35281",
"countryCode": "US",
"addressType": null
},
"orderDate": "2021-09-01T00:44:29Z",
"requiredShipDate": "2021-09-05T00:44:29Z",
"vendorCode": "VENDORID",
"promisedDeliveryDate": "2021-09-08T00:44:29Z",
"isPriorityShipment": false,
"isPslipRequired": false,
"totalAmount": 3861.92,
"orderItems": [
{
"itemNumber": 1,
"productName": "libero. Donec consectetuer mauris id sapien. Cras dolor dolor, tempus",
"sku": "SKU-00VEP41B",
"asin": "D6VZ9NYSIG",
"quantity": 4,
"quantityUnit": "Each",
"totalCost": 161.68,
"totalPrice": 161.68,
"currency": "USD",
"giftMessage": "Happy Birth Day!",
"description": null,
"weightUnit": null,
"dimUnit": null,
"weight": null,
"length": null,
"width": null,
"height": null,
"boxes": null,
"singleLabel": null,
"lineNumbers": null,
"cartons": null,
"itemsPerPackage": null
},
{
"itemNumber": 2,
"productName": "vulputate ullamcorper magna. Sed eu eros. Nam consequat dolor vitae",
"sku": "SKU-11OJQ03I",
"asin": "L3LR9NTQBH",
"quantity": 4,
"quantityUnit": "Each",
"totalCost": 3343.24,
"totalPrice": 3343.24,
"currency": "USD",
"giftMessage": null,
"description": null,
"weightUnit": null,
"dimUnit": null,
"weight": null,
"length": null,
"width": null,
"height": null,
"boxes": null,
"singleLabel": null,
"lineNumbers": null,
"cartons": null,
"itemsPerPackage": null
},
{
"itemNumber": 3,
"productName": "mollis non, cursus non, egestas a, dui. Cras pellentesque. Sed",
"sku": "SKU-82BXT32F",
"asin": "A2EA6BQLBE",
"quantity": 4,
"quantityUnit": "Each",
"totalCost": 357.0,
"totalPrice": 357.0,
"currency": "USD",
"giftMessage": null,
"description": null,
"weightUnit": null,
"dimUnit": null,
"weight": null,
"length": null,
"width": null,
"height": null,
"boxes": null,
"singleLabel": null,
"lineNumbers": null,
"cartons": null,
"itemsPerPackage": null
}
],
"packages": [],
"owner": "19ce0c99-f9df-4c53-870b-5df8f5d41afa",
"fulfillment": null,
"acknowledgmentStatus": null,
"statusTemp": null,
"labelFormat": null,
"isGift": true,
"missAsin": null,
"getLabels": null,
"skus": "SKU-00VEP41B(4),SKU-11OJQ03I(4),SKU-82BXT32F(4)",
"shipMethods": "AMZL_AIR",
"singleLabel": null,
"createdAt": "2021-09-01T01:14:00.345Z",
"updatedAt": "2021-09-01T01:14:00.345Z",
"expiredAt": 1638234840,
"methodCode": null,
"originalCarrier": null,
"shipFrom": null,
"transationId": null,
"ltl": null,
"version": 1
},
{
"id": "e381e732-0ac1-11ec-acf4-410d01a7d4ff",
"orderId": "NOdzQn7dJf",
"instance": "AMAZON#123123123",
"status": "NEW",
"warehouseId": "WQRE",
"customerOrderNumber": "217-14494387-18534075",
"shippingAddress": {
"city": "New Orleans",
"stateOrRegion": "LA",
"postalCode": "13293",
"countryCode": "US",
"addressType": null
},
"orderDate": "2021-09-01T00:47:38Z",
"requiredShipDate": "2021-09-05T00:47:38Z",
"vendorCode": "VENDORID",
"promisedDeliveryDate": "2021-09-08T00:47:38Z",
"isPriorityShipment": false,
"isPslipRequired": false,
"totalAmount": 7363.38,
"orderItems": [
{
"itemNumber": 1,
"productName": "ornare placerat, orci lacus vestibulum lorem, sit amet ultricies sem",
"sku": "SKU-74QZD56S",
"asin": "G0CK2KIAUV",
"quantity": 6,
"quantityUnit": "Each",
"totalCost": 1743.9,
"totalPrice": 1743.9,
"currency": "USD",
"giftMessage": null,
"description": null,
"weightUnit": null,
"dimUnit": null,
"weight": null,
"length": null,
"width": null,
"height": null,
"boxes": null,
"singleLabel": null,
"lineNumbers": null,
"cartons": null,
"itemsPerPackage": null
},
{
"itemNumber": 2,
"productName": "Morbi non sapien molestie orci tincidunt adipiscing. Mauris molestie pharetra",
"sku": "SKU-19JKL11X",
"asin": "W2PB1KBRWO",
"quantity": 6,
"quantityUnit": "Each",
"totalCost": 50.82,
"totalPrice": 50.82,
"currency": "USD",
"giftMessage": null,
"description": null,
"weightUnit": null,
"dimUnit": null,
"weight": null,
"length": null,
"width": null,
"height": null,
"boxes": null,
"singleLabel": null,
"lineNumbers": null,
"cartons": null,
"itemsPerPackage": null
},
{
"itemNumber": 3,
"productName": "tellus. Nunc lectus pede, ultrices a, auctor non, feugiat nec,",
"sku": "SKU-54ATR51V",
"asin": "B1WS1KSWYC",
"quantity": 6,
"quantityUnit": "Each",
"totalCost": 5568.66,
"totalPrice": 5568.66,
"currency": "USD",
"giftMessage": null,
"description": null,
"weightUnit": null,
"dimUnit": null,
"weight": null,
"length": null,
"width": null,
"height": null,
"boxes": null,
"singleLabel": null,
"lineNumbers": null,
"cartons": null,
"itemsPerPackage": null
}
],
"packages": [],
"owner": "19ce0c99-f9df-4c53-870b-5df8f5d41afa",
"fulfillment": null,
"acknowledgmentStatus": null,
"statusTemp": null,
"labelFormat": null,
"isGift": false,
"missAsin": null,
"getLabels": null,
"skus": "SKU-19JKL11X(6),SKU-54ATR51V(6),SKU-74QZD56S(6)",
"shipMethods": "UPS_GROUND",
"singleLabel": null,
"createdAt": "2021-09-01T01:14:00.355Z",
"updatedAt": "2021-09-01T01:14:00.355Z",
"expiredAt": 1638234840,
"methodCode": null,
"originalCarrier": null,
"shipFrom": null,
"transationId": null,
"ltl": null,
"version": 1
},
{
"id": "e381e730-0ac1-11ec-acf4-410d01a7d4ff",
"orderId": "6fybjbcDXr",
"instance": "AMAZON#123123123",
"status": "NEW",
"warehouseId": "XYZQ",
"customerOrderNumber": "402-12482017-13294305",
"shippingAddress": {
"city": "Allentown",
"stateOrRegion": "PA",
"postalCode": "87967",
"countryCode": "US",
"addressType": null
},
"orderDate": "2021-09-01T01:03:26Z",
"requiredShipDate": "2021-09-05T01:03:26Z",
"vendorCode": "VENDORID",
"promisedDeliveryDate": "2021-09-09T01:03:26Z",
"isPriorityShipment": false,
"isPslipRequired": false,
"totalAmount": 6889.89,
"orderItems": [
{
"itemNumber": 1,
"productName": "arcu. Sed et libero. Proin mi. Aliquam gravida mauris ut",
"sku": "SKU-25DPP12L",
"asin": "Q7ZB6AICFZ",
"quantity": 7,
"quantityUnit": "Each",
"totalCost": 228.48,
"totalPrice": 228.48,
"currency": "USD",
"giftMessage": "Happy Birth Day!",
"description": null,
"weightUnit": null,
"dimUnit": null,
"weight": null,
"length": null,
"width": null,
"height": null,
"boxes": null,
"singleLabel": null,
"lineNumbers": null,
"cartons": null,
"itemsPerPackage": null
},
{
"itemNumber": 2,
"productName": "ac, fermentum vel, mauris. Integer sem elit, pharetra ut, pharetra",
"sku": "SKU-06QOG86L",
"asin": "O0LM1EBAIT",
"quantity": 7,
"quantityUnit": "Each",
"totalCost": 6661.41,
"totalPrice": 6661.41,
"currency": "USD",
"giftMessage": null,
"description": null,
"weightUnit": null,
"dimUnit": null,
"weight": null,
"length": null,
"width": null,
"height": null,
"boxes": null,
"singleLabel": null,
"lineNumbers": null,
"cartons": null,
"itemsPerPackage": null
}
],
"packages": [],
"owner": "19ce0c99-f9df-4c53-870b-5df8f5d41afa",
"fulfillment": null,
"acknowledgmentStatus": null,
"statusTemp": null,
"labelFormat": null,
"isGift": true,
"missAsin": null,
"getLabels": null,
"skus": "SKU-06QOG86L(7),SKU-25DPP12L(7)",
"shipMethods": "AMZL_AIR",
"singleLabel": null,
"createdAt": "2021-09-01T01:14:00.355Z",
"updatedAt": "2021-09-01T01:14:00.355Z",
"expiredAt": 1638234840,
"methodCode": null,
"originalCarrier": null,
"shipFrom": null,
"transationId": null,
"ltl": null,
"version": 1
},
{
"id": "e381e731-0ac1-11ec-acf4-410d01a7d4ff",
"orderId": "9HfAkAMoG5",
"instance": "AMAZON#123123123",
"status": "NEW",
"warehouseId": "WQRE",
"customerOrderNumber": "255-10699742-19541947",
"shippingAddress": {
"city": "Green Bay",
"stateOrRegion": "WI",
"postalCode": "18001",
"countryCode": "US",
"addressType": null
},
"orderDate": "2021-09-01T00:51:19Z",
"requiredShipDate": "2021-09-05T00:51:19Z",
"vendorCode": "VENDORID",
"promisedDeliveryDate": "2021-09-07T00:51:19Z",
"isPriorityShipment": false,
"isPslipRequired": false,
"totalAmount": 770.2,
"orderItems": [
{
"itemNumber": 1,
"productName": "cubilia Curae; Donec tincidunt. Donec vitae erat vel pede blandit",
"sku": "SKU-43KYS90Y",
"asin": "Z5ZQ5WTRSH",
"quantity": 10,
"quantityUnit": "Each",
"totalCost": 770.2,
"totalPrice": 770.2,
"currency": "USD",
"giftMessage": "Happy Birth Day!",
"description": null,
"weightUnit": null,
"dimUnit": null,
"weight": null,
"length": null,
"width": null,
"height": null,
"boxes": null,
"singleLabel": null,
"lineNumbers": null,
"cartons": null,
"itemsPerPackage": null
}
],
"packages": [],
"owner": "19ce0c99-f9df-4c53-870b-5df8f5d41afa",
"fulfillment": null,
"acknowledgmentStatus": null,
"statusTemp": null,
"labelFormat": null,
"isGift": true,
"missAsin": null,
"getLabels": null,
"skus": "SKU-43KYS90Y(10)",
"shipMethods": "AMZL_AIR",
"singleLabel": null,
"createdAt": "2021-09-01T01:14:00.355Z",
"updatedAt": "2021-09-01T01:14:00.355Z",
"expiredAt": 1638234840,
"methodCode": null,
"originalCarrier": null,
"shipFrom": null,
"transationId": null,
"ltl": null,
"version": 1
},
{
"id": "e3820e44-0ac1-11ec-acf4-410d01a7d4ff",
"orderId": "vIMfwJUX8u",
"instance": "AMAZON#123123123",
"status": "NEW",
"warehouseId": "KLOP",
"customerOrderNumber": "134-14387112-18209197",
"shippingAddress": {
"city": "Hilo",
"stateOrRegion": "HI",
"postalCode": "32361",
"countryCode": "US",
"addressType": null
},
"orderDate": "2021-09-01T00:59:11Z",
"requiredShipDate": "2021-09-04T00:59:11Z",
"vendorCode": "VENDORID",
"promisedDeliveryDate": "2021-09-09T00:59:11Z",
"isPriorityShipment": false,
"isPslipRequired": false,
"totalAmount": 726.45,
"orderItems": [
{
"itemNumber": 1,
"productName": "vehicula et, rutrum eu, ultrices sit amet, risus. Donec nibh",
"sku": "SKU-90BQF87X",
"asin": "O4KU5CADYL",
"quantity": 1,
"quantityUnit": "Each",
"totalCost": 726.45,
"totalPrice": 726.45,
"currency": "USD",
"giftMessage": "Happy Birth Day!",
"description": null,
"weightUnit": null,
"dimUnit": null,
"weight": null,
"length": null,
"width": null,
"height": null,
"boxes": null,
"singleLabel": null,
"lineNumbers": null,
"cartons": null,
"itemsPerPackage": null
}
],
"packages": [],
"owner": "19ce0c99-f9df-4c53-870b-5df8f5d41afa",
"fulfillment": null,
"acknowledgmentStatus": null,
"statusTemp": null,
"labelFormat": null,
"isGift": true,
"missAsin": null,
"getLabels": null,
"skus": "SKU-90BQF87X(1)",
"shipMethods": "AMZL_AIR",
"singleLabel": null,
"createdAt": "2021-09-01T01:14:00.356Z",
"updatedAt": "2021-09-01T01:14:00.356Z",
"expiredAt": 1638234840,
"methodCode": null,
"originalCarrier": null,
"shipFrom": null,
"transationId": null,
"ltl": null,
"version": 1
}
],
"nextToken": "eyJ2ZXJzaW9uIjoyLCJ0b2tlbiI6IkFRSUNBSGg5OUIvN3BjWU41eE96NDZJMW5GeGM4WUNGeG1acmFOMUpqajZLWkFDQ25BSG95ZVJRbnB4d21mV0E0VkNCOW5GK0FBQUVERENDQkFnR0NTcUdTSWIzRFFFSEJxQ0NBL2t3Z2dQMUFnRUFNSUlEN2dZSktvWklodmNOQVFjQk1CNEdDV0NHU0FGbEF3UUJMakFSQkF4ZWQ1U000eUNKeDFPU3ptUUNBUkNBZ2dPL1NSNldlSExTaEEwQjRwYjJaNW83N3VrSUp2N09YaitFa2tPUERjSDd4Z1cwUU8xbzRIdVUxSHBvTGZsQzNPSkxHdndqd1BqY05hUDVyZytVdjF0VnJtZ2swSnhKRnZSTWxvbjVMcXI5T1hBSlh2eEZEeXFnZzhta0d1cndyWldkNllCRzh5a2dQc0tvRzYyTmlnS1lSSlo5dlhTTzRxUis3L3JwN0ordlJ3enExNDV3OU1jVE5DejZNNGZnT2dZSHhIUE0yMUgzM0plcm01ZkNmd1BjUEVyaE90a2VxdkYzbEdkc3NsQ1pZNzJBdi9NSkpiZWpuTXgydkk3NWxUdGdMeUlLTFFHM1A0VmVLTjdUdDJjVnBSRitibUlRTTg5Y0I0NHc2TENqMlNwaW1oRW5GMmpOdnRvVzJ3R21ET2cwRTVrRmNrb0R5bnNWMVR1Q3FLRXhZbW1hTlpNU09JSXZzSE5LSnpvNFAvUmdvb2hFdU42dEV4UkdqN3laQis3RVV1V3ViVGgzdkpLWitDK2dIQTZBWHpIS0lVZXpZTy9SMmNQZEJjV3lWKzRHcGU4VVdPaTVjeFkxOStYbkVDbU41bk50UU5OV3o3OHRhVjhqQkxtUzZRSTY5V1N6RndSVGZkODZ4NlYrbUhhQW9hbm9oS1ZreDlJN3lsclptMm5na1VRUDgrVkkxR0NETHRJT1NVRzFaRXZuc2hEaFVBblV3V0VsKzhrM2VOU01uRUVYcHJwS1JiajJNTlcxM0MwLzJOdmJjVngvUTdoOTFvZnV2ZVpVaHpybWxQZlNRTWdzc0RiRm9ZV1Y5TVpLRStjK21IcWlKbWNUVHQyRW1BK25Jc0djeWt0UEVqb2t3bE55dGR2VjFjK2UxNmlEQy85WXV5M0NWRk5TQWhENHhoZ0ZZMVhEMmtjd1pDc0l3WjBncXEyWXhMdFdaVFZhR2E5MU00MjV4am1iMFZSaStZOTdNS1A4M3ZITVY1Tk9aZ0tEbFRubDZzeEdjUi9kM0lxd3R5OWgrWk42U3lFZ3JEVFdzenJybGE0WENqR00zSzQ2UEZKODR0NzdRalVsRU5WcDFySnY1VW82Yjg5aGl1b1d2NWVPOHJJMTBsSlpRd2ExTUVnbVZDcW1LNlBVdU1zQU1FQlAwUVhpSWhFY3ZCVVBUVy9kZGV6SlBoSlJZSEpyaHA1UEpWRGdZTjBKUlN5Q3IvZXh0OUg4ekZxS1B3eG1sb1BiSUxIUEUwVHd4cVI5RzRjdUNVbHVUcUdXTUJVL1Y3dnJaeWl3bkhVUWZXdXhNdm5OY2Q5emJSemxkSmNSTTd1V2tHMXFqbW5NVm1CemZPNUtrQVB4R2ExVWFNS2ltaE5LcFVsWGRJQXRMYisrdXh5MkRUQitCUmdPandhUXFWS3FNcEk3V1hTVjhlR2pMMTFZY1VlRDl3UlpJazgyblNmQVkzdVA1TFNWNUZDdjhvSWgvR3BFMFhsUlplWTkxSnVBb1BSTXg3VDFpdE9aeG1oVG1OSXJ2U3FWQnpldUJQRVo3T1IyNkFMMUJOcmVUSG5aUno0VVlEWU5BZHVVaU1rU2txdDlKdzU2aXFhT2dPMndSaWQyeXZ1SGxYbTdPU0hyTGlwdktDZlJ3R1k1K1JEd1RqS3hCeG5ocThWM3h2RzBBTi9ram0yTU5DeXl2UVAwMjVZZmFhRTBnZFk9In0="
}
}
}
Single Order Query
1. Definition
Request the details of a single order
2.Request Method
POST
3.Request Header
x-api-key:<Check with the support for API key>
4.GraphQL Query
query PublicApiOrderById(
$credentials: AppCredentialsInput!
$instance: InstanceInput!
$orderId: String!
) {
publicApiOrderById(
credentials: $credentials
instance: $instance
orderId: $orderId
) {
order {
id
orderId
instance
inst
status
warehouseId
customerOrderNumber
orderDate
requiredShipDate
vendorCode
storeNum
promisedDeliveryDate
isPriorityShipment
isPslipRequired
totalAmount
owner
statusTemp
labelFormat
isGift
missAsin
getLabels
skus
shipMethods
singleLabel
createdAt
updatedAt
expiredAt
methodCode
originalCarrier
transationId
ltl
representative
soldTo
ssOrderId
orderItems {
itemNumber
productName
sku
asin
quantity
quantityUnit
totalCost
totalPrice
currency
giftMessage
description
weightUnit
dimUnit
weight
length
width
height
boxes
singleLabel
lineNumbers
lineNum
cartons
itemsPerPackage
ltl
}
packages {
packageId
itemNumbers
boxNumber
trackingId
shipMethod
shipMethodName
sscc
packSize
}
}
labels
}
}
5.GrapheQl Variables
Example：Query the order of 7Sl1ewczAL
{
"credentials":
{
"appId":"<Request the appId from support>",
"appSecret":"<Request the appSecret from support>"
},
"instance":
{
"clientId":"3e763660-57d1-11ee-818e-5ba160fea123",
"platform":"AMAZON"
},
"orderId":"7Sl1ewczAL"
}
6.Response
Example：The order detials of 7Sl1ewczAL
{
"data": {
"publicApiOrderById": {
"order": {
"id": "b581e959-57d3-11ee-818e-5ba160fea123",
"orderId": "7Sl1ewczAL",
"instance": "AMAZON#3e763660-57d1-11ee-818e-5ba160fea123",
"inst": "AMAZON#3e763660-57d1-11ee-818e-5ba160fea123",
"status": "FULFILLING",
"warehouseId": "WQRE",
"customerOrderNumber": "231-11081140-18604164",
"orderDate": "2023-09-20T16:18:07Z",
"requiredShipDate": "2023-09-22T16:18:07Z",
"vendorCode": "VENDORID",
"storeNum": null,
"promisedDeliveryDate": "2023-09-28T16:18:07Z",
"isPriorityShipment": false,
"isPslipRequired": false,
"totalAmount": 2897.68,
"owner": "d65753a8-5d29-4f1d-a313-9f8133bbbb80",
"statusTemp": null,
"labelFormat": "PNG",
"isGift": false,
"missAsin": null,
"getLabels": null,
"skus": "SKU-18LFA24G(4),SKU-31NYK93J(4),SKU-61UKC06C(4)",
"shipMethods": "UPS_2ND_DAY_AIR",
"singleLabel": false,
"createdAt": "2023-09-20T16:35:28.997Z",
"updatedAt": "2023-09-20T16:38:12.915Z",
"expiredAt": 1703003728,
"methodCode": null,
"originalCarrier": null,
"transationId": null,
"ltl": null,
"representative": null,
"soldTo": null,
"ssOrderId": null,
"orderItems": [
{
"itemNumber": 1,
"productName": "eu, odio. Phasellus at augue id ante dictum cursus. Nunc",
"sku": "SKU-18LFA24G",
"asin": "X1FI1HWBJA",
"quantity": 4,
"quantityUnit": "Each",
"totalCost": 87.2,
"totalPrice": 87.2,
"currency": "USD",
"giftMessage": null,
"description": null,
"weightUnit": "LB",
"dimUnit": "IN",
"weight": 71.0,
"length": 16.0,
"width": 36.0,
"height": 49.0,
"boxes": 1,
"singleLabel": true,
"lineNumbers": null,
"lineNum": null,
"cartons": null,
"itemsPerPackage": null,
"ltl": null
},
{
"itemNumber": 2,
"productName": "neque. Nullam nisl. Maecenas malesuada fringilla est. Mauris eu turpis.",
"sku": "SKU-31NYK93J",
"asin": "Z5WO1KHESA",
"quantity": 4,
"quantityUnit": "Each",
"totalCost": 2800.32,
"totalPrice": 2800.32,
"currency": "USD",
"giftMessage": null,
"description": null,
"weightUnit": "LB",
"dimUnit": "IN",
"weight": 146.0,
"length": 50.0,
"width": 47.0,
"height": 36.0,
"boxes": 1,
"singleLabel": true,
"lineNumbers": null,
"lineNum": null,
"cartons": null,
"itemsPerPackage": null,
"ltl": null
},
{
"itemNumber": 3,
"productName": "velit. Quisque varius. Nam porttitor scelerisque neque. Nullam nisl. Maecenas",
"sku": "SKU-61UKC06C",
"asin": "U5YD1DVYNK",
"quantity": 4,
"quantityUnit": "Each",
"totalCost": 10.16,
"totalPrice": 10.16,
"currency": "USD",
"giftMessage": null,
"description": null,
"weightUnit": "LB",
"dimUnit": "IN",
"weight": 196.0,
"length": 43.0,
"width": 76.0,
"height": 90.0,
"boxes": 1,
"singleLabel": true,
"lineNumbers": null,
"lineNum": null,
"cartons": null,
"itemsPerPackage": null,
"ltl": null
}
],
"packages": [
{
"packageId": "0001",
"itemNumbers": [
"1",
"2",
"3"
],
"boxNumber": 1,
"trackingId": "VA3rbb5-TOW6ghVrGUnlbs5Eeg5ke",
"shipMethod": "UPS_2ND_DAY_AIR",
"shipMethodName": "Carrier(UPS_2ND_DAY_AIR)",
"sscc": null,
"packSize": "{\"e\":1652,\"l\":90,\"w\":76,\"h\":50,\"q\":12,\"qs\":[4,4,4]}"
},
{
"packageId": "0002",
"itemNumbers": [
"1",
"2",
"3"
],
"boxNumber": 2,
"trackingId": "ibLpT-j57B8eSKQzDu1NjDWzvIlmaZ",
"shipMethod": "UPS_2ND_DAY_AIR",
"shipMethodName": "Carrier(UPS_2ND_DAY_AIR)",
"sscc": null,
"packSize": "{\"e\":1652,\"l\":90,\"w\":76,\"h\":50,\"q\":12,\"qs\":[4,4,4]}"
},
{
"packageId": "0003",
"itemNumbers": [
"1",
"2",
"3"
],
"boxNumber": 3,
"trackingId": "akoCSWqHmsJ2JVctagWZ2CQB3Ev1X9",
"shipMethod": "UPS_2ND_DAY_AIR",
"shipMethodName": "Carrier(UPS_2ND_DAY_AIR)",
"sscc": null,
"packSize": "{\"e\":1652,\"l\":90,\"w\":76,\"h\":50,\"q\":12,\"qs\":[4,4,4]}"
}
]
},
"labels": [
"https://vendorautobucket182543-devb.s3.amazonaws.com/private/us-east-1%3A1a933056-fda8-4438-a6b9-cc66c8b257d3/AMAZON%233e763660-57d1-11ee-818e-5ba160fea123/label/7Sl1ewczAL-%23VA3rbb5-TOW6ghVrGUnlbs5Eeg5ke.PNG?AWSAccessKeyId=ASIA5YXEETNSDDXJI3O4&Expires=1697471018&Signature=MoKDOUoPP5BLXBpmkAycWrCB%2B5M%3D&X-Amzn-Trace-Id=Root%3D1-652d531f-23d942486dfc87c30b63c3a2%3BParent%3D2df5287534d7219a%3BSampled%3D0%3BLineage%3Db42f51ee%3A0&x-amz-security-token=IQoJb3JpZ2luX2VjEGAaCXVzLWVhc3QtMSJHMEUCIQCaeuMFMDI%2BghT9Wjrc4JPS12OzA%2F16fzPr%2BSr14iTjEAIgQIMxCj24tXFyKAcYjd6SqGylZR6xBb%2FcV2m5Et3sHQ4q8gIIeBAEGgw5NDY0NDQ5OTk1MjQiDHlH52ISBoK82tsp4yrPAtN%2Bd3J3vM5faRJpmDfOPmuELylwQpOvgTtZTPJqxeAtE7L4hCYPkxB6BcK7CS7hDTgOYGLkme8TpMBQTm7AU32ayLC7GsEC9%2FGlPcqDhhZnYdKA39mWPBoqahKRAgBTXNtwU%2FbnpPLY71%2FEEOFcj3kdczgsAhjCraV64M5VESPNmPDG5CHEAuY4r4dd13fBIJIYCFk4E73g3TzONZ4O2PD4OikJlN%2FSm2NtSrHGcLh1fZ5NoCZptiRJw71d7p%2BGchB3F%2FHVjZbkFRhiYMNMkCOnapFq9gjeIE49qsSAqzsQVUoG61pLvKQZQrJ9F0TBtvqE3b2PLSCVN%2B%2B2NjLCS6XFTFP2UlNFMimHGLZ38jradhRm15njvDTXnaQpoQ%2B7Ks6mWIsTneiSmiAPFnIfINs1BEWslx7b1gI5xTeC2p7IsWNqWGuKNX1GWPxxRQJYMJ%2BmtakGOp4BFvTDImexL%2BXMoGIbRuXo47IyooadwlKktISBrN7hqMVgf82B5jCE1hntLGRqtG1i1YvpSxcJ2fGMW1vL1YZtxbJ7Tv9VBCgyCKr8HtBu%2F09svb6YoEZNw1sBsV2M%2FQUQa0MaThTV0Fs%2BDrSkVZm2C0h4rBw%2B1KY10imrojLGQoOA3h35PaVzH%2Fmk9z7n0RDS1L3Us02gejzR2EaAa7Y%3D",
"https://vendorautobucket182543-devb.s3.amazonaws.com/private/us-east-1%3A1a933056-fda8-4438-a6b9-cc66c8b257d3/AMAZON%233e763660-57d1-11ee-818e-5ba160fea123/label/7Sl1ewczAL-%23ibLpT-j57B8eSKQzDu1NjDWzvIlmaZ.PNG?AWSAccessKeyId=ASIA5YXEETNSDDXJI3O4&Expires=1697471018&Signature=RMkBwZE0nhx1L8QHhmjswvoCodM%3D&X-Amzn-Trace-Id=Root%3D1-652d531f-23d942486dfc87c30b63c3a2%3BParent%3D2df5287534d7219a%3BSampled%3D0%3BLineage%3Db42f51ee%3A0&x-amz-security-token=IQoJb3JpZ2luX2VjEGAaCXVzLWVhc3QtMSJHMEUCIQCaeuMFMDI%2BghT9Wjrc4JPS12OzA%2F16fzPr%2BSr14iTjEAIgQIMxCj24tXFyKAcYjd6SqGylZR6xBb%2FcV2m5Et3sHQ4q8gIIeBAEGgw5NDY0NDQ5OTk1MjQiDHlH52ISBoK82tsp4yrPAtN%2Bd3J3vM5faRJpmDfOPmuELylwQpOvgTtZTPJqxeAtE7L4hCYPkxB6BcK7CS7hDTgOYGLkme8TpMBQTm7AU32ayLC7GsEC9%2FGlPcqDhhZnYdKA39mWPBoqahKRAgBTXNtwU%2FbnpPLY71%2FEEOFcj3kdczgsAhjCraV64M5VESPNmPDG5CHEAuY4r4dd13fBIJIYCFk4E73g3TzONZ4O2PD4OikJlN%2FSm2NtSrHGcLh1fZ5NoCZptiRJw71d7p%2BGchB3F%2FHVjZbkFRhiYMNMkCOnapFq9gjeIE49qsSAqzsQVUoG61pLvKQZQrJ9F0TBtvqE3b2PLSCVN%2B%2B2NjLCS6XFTFP2UlNFMimHGLZ38jradhRm15njvDTXnaQpoQ%2B7Ks6mWIsTneiSmiAPFnIfINs1BEWslx7b1gI5xTeC2p7IsWNqWGuKNX1GWPxxRQJYMJ%2BmtakGOp4BFvTDImexL%2BXMoGIbRuXo47IyooadwlKktISBrN7hqMVgf82B5jCE1hntLGRqtG1i1YvpSxcJ2fGMW1vL1YZtxbJ7Tv9VBCgyCKr8HtBu%2F09svb6YoEZNw1sBsV2M%2FQUQa0MaThTV0Fs%2BDrSkVZm2C0h4rBw%2B1KY10imrojLGQoOA3h35PaVzH%2Fmk9z7n0RDS1L3Us02gejzR2EaAa7Y%3D",
"https://vendorautobucket182543-devb.s3.amazonaws.com/private/us-east-1%3A1a933056-fda8-4438-a6b9-cc66c8b257d3/AMAZON%233e763660-57d1-11ee-818e-5ba160fea123/label/7Sl1ewczAL-%23akoCSWqHmsJ2JVctagWZ2CQB3Ev1X9.PNG?AWSAccessKeyId=ASIA5YXEETNSDDXJI3O4&Expires=1697471018&Signature=eXplc%2ByJAUlqUNMTERRC74jUqm0%3D&X-Amzn-Trace-Id=Root%3D1-652d531f-23d942486dfc87c30b63c3a2%3BParent%3D2df5287534d7219a%3BSampled%3D0%3BLineage%3Db42f51ee%3A0&x-amz-security-token=IQoJb3JpZ2luX2VjEGAaCXVzLWVhc3QtMSJHMEUCIQCaeuMFMDI%2BghT9Wjrc4JPS12OzA%2F16fzPr%2BSr14iTjEAIgQIMxCj24tXFyKAcYjd6SqGylZR6xBb%2FcV2m5Et3sHQ4q8gIIeBAEGgw5NDY0NDQ5OTk1MjQiDHlH52ISBoK82tsp4yrPAtN%2Bd3J3vM5faRJpmDfOPmuELylwQpOvgTtZTPJqxeAtE7L4hCYPkxB6BcK7CS7hDTgOYGLkme8TpMBQTm7AU32ayLC7GsEC9%2FGlPcqDhhZnYdKA39mWPBoqahKRAgBTXNtwU%2FbnpPLY71%2FEEOFcj3kdczgsAhjCraV64M5VESPNmPDG5CHEAuY4r4dd13fBIJIYCFk4E73g3TzONZ4O2PD4OikJlN%2FSm2NtSrHGcLh1fZ5NoCZptiRJw71d7p%2BGchB3F%2FHVjZbkFRhiYMNMkCOnapFq9gjeIE49qsSAqzsQVUoG61pLvKQZQrJ9F0TBtvqE3b2PLSCVN%2B%2B2NjLCS6XFTFP2UlNFMimHGLZ38jradhRm15njvDTXnaQpoQ%2B7Ks6mWIsTneiSmiAPFnIfINs1BEWslx7b1gI5xTeC2p7IsWNqWGuKNX1GWPxxRQJYMJ%2BmtakGOp4BFvTDImexL%2BXMoGIbRuXo47IyooadwlKktISBrN7hqMVgf82B5jCE1hntLGRqtG1i1YvpSxcJ2fGMW1vL1YZtxbJ7Tv9VBCgyCKr8HtBu%2F09svb6YoEZNw1sBsV2M%2FQUQa0MaThTV0Fs%2BDrSkVZm2C0h4rBw%2B1KY10imrojLGQoOA3h35PaVzH%2Fmk9z7n0RDS1L3Us02gejzR2EaAa7Y%3D"
]
}
}
}
Process Orders
1.Definition
Available Operations：
- ACCEPT
- REQUEST_LABEL
- GET_LABEL
- CANCEL_NEW
- CANCEL
- DELETE
- CONFIRM。
2.Request Method
POST
3.Request Header
x-api-key:<Check with the support for API key>
4. GraphQl Query
mutation PublicApiOrderCmd(
$credentials: AppCredentialsInput!
$instance: InstanceInput!
$orders: [String!]!
$cmd: String!
$ack: AcknowledgmentStatusA
) {
publicApiOrderCmd(
credentials: $credentials
instance: $instance
orders: $orders
cmd: $cmd
ack: $ack
) {
code
message
ok
no
}
}
5. GraphQl Variables
Example：Cancel the order of Kgd48MRybEH with the code of "02" and the description of "Canceled due to missing/invalid SKU"。
{
"credentials":
{
"appId":"<Request the appId from support>",
"appSecret":"<Request the appSecret from support>"
},
"instance":
{
"clientId":"3e763660-57d1-11ee-818e-5ba160fea123",
"platform":"AMAZON"
},
"orders":["Kgd48MRybEH"],
"cmd":"CANCEL_NEW",
"ack":
{
"code":"02",
"description":"Canceled due to missing/invalid SKU"
}
}
The cmd field can be one of the following operations
ACCEPT：Accept Orders
REQUEST_LABEL：Request Shipping Labels
GET_LABEL：Get Shipping Labels
CANCEL_NEW：Cancel orders in new status
CANCEL：Cancel orders not in new status
DELETE：Delete orders only in VendorAuto (No impact on Vendor Central orders)
CONFIRM：Confirm shipping of orders
The codes and description of the ack field can be found here：
{"code": "02", "description": 'Canceled due to missing/invalid SKU'},
{"code": "03", "description": 'Canceled out of stock'},
{"code": "04", "description": 'Canceled due to duplicate Amazon Ship ID'},
{"code": "05", "description": 'Canceled due to missing/invalid Bill To Location Code'},
{"code": "06", "description": 'Canceled due to missing/invalid Ship From Location Code'},
{"code": "07", "description": 'Canceled due to missing/invalid Customer Ship to Name'},
{"code": "08", "description": 'Canceled due to missing/invalid Customer Ship to Address Line 1'},
{"code": "09", "description": 'Canceled due to missing/invalid Customer Ship to City'},
{"code": "10", "description": 'Canceled due to missing/invalid Customer Ship to State'},
{"code": "11", "description": 'Canceled due to missing/invalid Customer Ship to Postal Code'},
{"code": "12", "description": 'Canceled due to missing/invalid Customer Ship to Country Code'},
{"code": "13", "description": 'Canceled due to missing/invalid Shipping Carrier/Shipping Method'},
{"code": "20", "description": 'Canceled due to missing/invalid Unit Price'},
{"code": "21", "description": 'Canceled due to missing/invalid Ship to Address Line 2'},
{"code": "22", "description": 'Canceled due to missing/invalid Ship to Address Line 3'},
{"code": "50", "description": 'Canceled due to Tax Nexus Issue'},
{"code": "51", "description": 'Canceled due to Restricted SKU/Qty'},
{"code": "53", "description": 'Canceled due to USPS >$400'},
{"code": "54", "description": 'Canceled due to Missing AmazonShipID'},
{"code": "55", "description": 'Canceled due to Missing AmazonOrderID'},
{"code": "56", "description": 'Canceled due to Missing LineItemId'},
{"code": "71", "description": 'Canceled due to discontinued item'}
Example：Cancel the orders of yrmYbmfG6w and fwXnniunqhL in ACCEPTED status
{
"credentials":
{
"appId":"<Request the appId from support>",
"appSecret":"<Request the appSecret from support>"
},
"instance":
{
"clientId":"3e763660-57d1-11ee-818e-5ba160fea123",
"platform":"AMAZON"
},
"orders":["yrmYbmfG6w","fwXnniunqhL"],
"cmd":"CANCEL",
"ack":{
"code":"",
"description":""
}
}
Example：Accept the order of 7X_s_ZFQdIc
{
"credentials":
{
"appId":"<Request the appId from support>",
"appSecret":"<Request the appSecret from support>"
},
"instance":
{
"clientId":"3e763660-57d1-11ee-818e-5ba160fea123",
"platform":"AMAZON"
},
"orders":["7X_s_ZFQdIc"],
"cmd":"ACCEPT",
"ack":{"code":"","description":""}
}
Example：Request Label for the order of 7X_s_ZFQdIc
{
"credentials":
{
"appId":"<Request the appId from support>",
"appSecret":"<Request the appSecret from support>"
},
"instance":
{
"clientId":"3e763660-57d1-11ee-818e-5ba160fea123",
"platform":"AMAZON"
},
"orders":["7X_s_ZFQdIc"],
"cmd":"REQUEST_LABEL",
"ack":{"code":"","description":""}
}
Example：Get label for the order of 7X_s_ZFQdIc
{
"credentials":
{
"appId":"<Request the appId from support>",
"appSecret":"<Request the appSecret from support>"
},
"instance":
{
"clientId":"3e763660-57d1-11ee-818e-5ba160fea123",
"platform":"AMAZON"
},
"orders":["7X_s_ZFQdIc"],
"cmd":"GET_LABEL",
"ack":{"code":"","description":""}
}
Example：Confirm the order of 7X_s_ZFQdIc
{
"credentials":
{
"appId":"<Request the appId from support>",
"appSecret":"<Request the appSecret from support>"
},
"instance":{
"clientId":"3e763660-57d1-11ee-818e-5ba160fea123",
"platform":"AMAZON"
},
"orders":["7X_s_ZFQdIc"],
"cmd":"CONFIRM",
"ack":{"code":"","description":""}
}
Example：Delete the order of 6Q5e0FFraKu
{
"credentials":{
"appId":"<Request the appId from support>",
"appSecret":"<Request the appSecret from support>"
},
"instance":{
"clientId":"3e763660-57d1-11ee-818e-5ba160fea123",
"platform":"AMAZON"
},
"orders":["6Q5e0FFraKu"],
"cmd":"DELETE",
"ack":{"code":"","description":""}
}
6.Response
Example：Successful update returns code 1
{
"data": {
"publicApiOrderCmd": {
"code": 1,
"message": "20cfb4e0-6c0a-11ee-940e-91c21dc1be78",
"ok": 0,
"no": 1
}
}
}