This operation returns a list of orders that match the provided search criteria.
Requested order has been retrived sucessfully.
Invalid request
The request could not be authorized
The request could not be completed due to an internal error
{- "filters": [
- {
- "name": "orderId",
- "value": [
- "PBqTYEhO31JY"
]
}
], - "page": 0,
- "size": 0
}{- "orders": [
- {
- "orderInfo": {
- "orderId": "PBqTYEhO31JY",
- "orderNumber": "ORD123456",
- "status": "UNFULFILLED",
- "orderCreateDate": "0001-01-01T00:00:00Z",
- "sourceFlowType": "API",
- "createdBy": "0oa2hlagtvtaETd8x0h8",
- "customerInfo": {
- "firstName": "John",
- "lastName": "Doe",
- "email": "john.doe@example.com",
- "customerId": "CUST12345"
}, - "orderMessage": {
- "type": "GIFT",
- "message": "Happy Birthday! Enjoy your gift."
}, - "items": [
- {
- "customProductId": "string",
- "itemId": "SKU12345",
- "description": "Wireless mouse with USB receiver",
- "hSTariffCode": "847160",
- "hSTariffCodeCountry": "US",
- "originCountryCode": "US",
- "originStateProvince": "",
- "quantity": 2,
- "unitPrice": 25,
- "unitWeight": {
- "unitOfMeasurement": "OZ",
- "weight": 12.5
}
}
], - "charges": {
- "currency": "USD",
- "billingStatus": "Paid",
- "gmv": 100,
- "subTotal": 90,
- "totalPaid": 100,
- "paymentType": "Credit Card"
}
}, - "orderShippingInfo": {
- "shippingReference": {
- "reference1": "reference1",
- "reference2": "reference2",
- "reference3": "reference3",
- "reference4": "reference4",
- "shipperReference": "Shipper123",
- "transportationReference": "TransRef2025",
- "shippingNotes": "Handle with care"
}, - "shippingPreferences": {
- "customCarrierCode": "string",
- "carrier": "UPS",
- "parcelId": "PKG-001",
- "parcelType": "PKG",
- "service": "2DA",
- "parcel": {
- "length": 2,
- "width": 1,
- "height": 1,
- "dimUnit": "IN",
- "weightUnit": "OZ",
- "weight": 2
}, - "specialServices": [
- {
- "inputParameters": [
- { }
], - "specialserviceId": "Ins"
}
], - "customs": {
- "customsInfo": {
- "certificateNumber": "98788877",
- "comments": "string",
- "currencyCode": "USD",
- "customsDeclaredValue": 0,
- "EELPFC": "NOEEI 30.36",
- "fromCustomsReference": "11111",
- "importerCustomsReference": "987654",
- "insuredAmount": 0,
- "invoiceNumber": "001189223",
- "licenseNumber": "456ABC123",
- "reasonForExport": "GIFT"
}
}, - "shipmentProvider": {
- "shipViaCode": "shipViaCode123"
}, - "shipmentOptions": {
- "packageDescription": "testpackageDescription"
}, - "dateOfShipment": "2026-01-30"
}
}
}
], - "pageInfo": {
- "total": 28,
- "pages": 3,
- "page": 1
}
}