API Documentation
Orders - Search Orders
Search through the orders and return information about orders that match search criteria..
It takes an arguments:
partnerBillingKey
- required - partner billing keygenericValues
- optional - any value which is related to order (partner name, address, phone, couponCode, etc…)lastName
- optional - partner last nameemail
- optional - partner emailpostalCode
- optional - partner postal codestartDate
- optional - start date of the date range when order was createdendDate
- optional - end date of the date range when order was createduniqueUserId
- optional - user IdpartnerId
- optional - partner IdpageSize
- optional - how many items to return in reponsepage
- optional - page number, how many items to skip
This request yields the following response:
{
"Orders": [
{
"Id": "9febf576-9943-4d29-9fb8-a11c011bdf0a",
"NiceId": "Pelto9febf576-9943-4d29-9fb8-a11c011bdf0a",
"SourceId": "7781",
"Items": [
{
"Sku": "Framd-1_25inWd-Blk-2in-Gloss-8x8",
"ProductId": 41,
"Product": "Framed Prints",
"Quantity": 1,
"Status": "Delivered",
"TrackingNumber": "1Z3R67830441752762",
"TrackingUrl": "http://wwwapps.ups.com/WebTracking/processInputRequest?sort_by=status&tracknums_displayed=1&TypeOfInquiryNumber=T&loc=en_us&InquiryNumber1=1z3r67830441752762",
"ShipCarrierName": "UPS",
"SourceId": "7781-1",
"Price": {
"Price": 0,
"CurrencyCode": "USD",
"FormattedPrice": "$0.00",
"CurrencyFormat": "${1}",
"CurrencyDigits": 2
},
"Shipments": [
{
"TrackingNumber": "1Z3R67830441752762",
"TrackingUrl": "http://wwwapps.ups.com/WebTracking/processInputRequest?sort_by=status&tracknums_displayed=1&TypeOfInquiryNumber=T&loc=en_us&InquiryNumber1=1z3r67830441752762",
"ShipCarrierName": "UPS"
},
...
]
}
],
"Total": {
"Price": 0,
"CurrencyCode": "USD",
"FormattedPrice": "$0.00",
"CurrencyFormat": "${1}",
"CurrencyDigits": 2
},
"ShippingAddress": {
...
},
"BillingAddress": {
...
}
}
}
}