Query Order List V2.0

PostedJanuary 14, 2022

The version 2.0 of Order Query API. The Order Query API v1.0 can only query orders which is already dispatched into warehouse, that means for special orders before dispatching (for example orders under status “Preorder” or “Pending”) into warehouse is not searchable. In this new version v2.0, all orders will be searchable.

URL: {API root URL}/orders?{query}
Method: GET

Request

URL Parameters

Parameter Name	Required	Data Type	Description
SortingField		String	Specify the sorting field for the query result list, below options are available:UploadTime. Default value if not specified.CloseTime. If current criteria will return some orders without CloseTime (status is not shipped), these orders will be listed in the top of the list.OrderNumber
SortingDirection		String	Below options are available:Descending. Default value if not specified.Ascending
PageSize	Y	Integer	Specify how many records to return in single call, up to 200.
PageNumber	Y	Integer	Specify which page you are querying, starts from 1.
FromTime		DateTime	The start date and time of the order uploading time, based on UTC.
ToTime		DateTime	The end date and time of the order uploading time, based on UTC.
FromCloseTime		DateTime	The start date and time of the order close time (the time when order is marked as Shipped), based on UTC.
ToCloseTime		DateTime	The end date and time of the order close time, based on UTC.
FromUpdateTime		DateTime	The start date and time when the order status or data is updated latest, based on UTC.
ToUpdateTime		DateTime	The end date and time when the order status or data is updated latest, based on UTC.
WarehouseCode		String	Specify the warehouse that the order allocated to, value could be “USCA01” or “USNJ01”, empty means querying all applicable warehouses.
OrderNumber		String	Order Number
ItemNumber		String	Exactly match by Item number in the order.
SalesChannel		String
ImportChannel		String	Specify the order creation channel, below options are available:Portal. For orders created by uploading order template file on OMS portal.API. For orders created by API.SPS. For orders created by external EDI partner SPS.Shopify. For orders imported by Shopify platform.
TrackingNumber		String	The tracking number that is used to fulfill the order.
ShipToName		String	Match the ship to name and ship to company of the order.
ShipToAddress		String	Match the ship to address line 1 and line 2.
WmsTransactionNumber		String	The unique transaction number of the order in Best Inc. warehouse
Status		String	The status of the order, refer to Order Status page for all available values.
DetailOption		String	Indicate how the order detail information will be included in the response body, nothing in this criteria means just return order header information without any detail information. Available options are below, accept multiple choices split by comma, for example “Items, Packages”.All. Include all below 4 detail information nodes if applicable.ItemsShippedItemsPackagesPallets

Response

Attribute List

Element Name	Data Type	Description
TotalCount	Integer	The count of returned records.
PageNumber	Integer	Same value in request body.
PageSize	Integer	Same value in request body.
PageCount	Integer	Indicate the total page count based the total record count and the page size.
Result	Array<Object>	The order data list.
Result / id	String	A unique ID to identity the order, this ID can be used to generate an URL to access the Order Detail page by below format: https://usportal.bestlogisticsglobal.com/orders/details/{id}
Result / CustomerCode	String	Your unique customer code assigned by Best system.
Result / OrderNumber	String	Specified unique number to identify your order.
Result / WarehouseCode	String	Indicate the Best Inc. fulfillment center ship your order.
Result / Status	String	The detail status of the order, refer to Order Status page for all available values.
Result / importChannel	String	Specify the order creation channel, below options are available:Portal. For orders created by uploading order template file on OMS portal. API. For orders created by API.SPS. For orders created by external EDI partner SPS.Shopify. For orders imported by Shopify platform.
Result / CustomerOrderType	String	The type of the order, check Customer Order Type Reference page regarding the detail and how to provide the right value.
Result / PONumber	String	Specified unique number to identify the purchase order if available.
Result / Reference1	String	Reference number 1 if specified.
Result / Reference2	String	Reference number 2 if specified.
Result / InvoiceNumber	String	Invoice number of the order if specified.
Result / SalesChannel	String	The retailer name if specified.
Result / StoreNumber	String	The store number from the retailer/ or channel for the order if specified.
Result / CarrierBillingType	String	Indicate the billing method for the shipping cost of the order.
Result / CarrierServiceLevel	String	Indicate the shipment service level for the order.
Result / Carrier	String	Indicate the carrier who will deliver the order related packages.
Result / CarrierService	String	Indicate the shipping service for related packages.
Result / CarrierServiceText	String	The description of the carrier service.
Result / ShipperCarrierAccount	String	The shipper carrier account number provided when create the order.
Result / CarrierAccountNumber	String	The billed carrier account number if specified when create the order.
Result / CarrierAccountZip	String	The zip code of the billed carrier account number if specified when create the order.
Result / OptionSignature	String	Indicate the option of delivery signature if selected.
Result / GiftWrapRequired	String	Indicate the option of GiftWrap
Result / GiftNotes	String	Indicate the Gift Notes if specified.
Result / ScheduledReleaseDate	String	Scheduled release date for current order.
Result / WarehouseNotes	String	Special instructions for warehouse operation.
Result / ShipToName	String	Recipient name
Result / ShipToCompany	String	Recipient company name
Result / ShipToStreetLine1	String	The destination address of shipment
Result / ShipToStreetLine2	String	The destination address 2 if available
Result / ShipToStreetLine3	String	The destination address 3 if available
Result / ShipToCity	String	The City of the Ship To address.
Result / ShipToState	String	The State of the Ship To address.
Result / ShipToZip	String	The Zip Code of the Ship To address.
Result / ShipToCountry	String	The Country Name of the Ship To address.
Result / ShipToPhone	String	The phone number of the order recipient if specified.
Result / ShipToEmail	String	The contact email address of the order recipient if specified.
Result / ShipFromName	String	The name of the sender.
Result / ShipFromCompany	String	The name of the sender company.
Result / ShipFromStreetLine1	String	Address line 1 of the shipping from address.
Result / ShipFromStreetLine2	String	Additional address info if specified.
Result / ShipFromStreetLine3	String	Additional address info if specified.
Result / ShipFromCity	String	The City of the Ship From address.
Result / ShipFromState	String	The State of the Ship From address.
Result / ShipFromZip	String	The Zip Code of the Ship From address.
Result / ShipFromCountry	String	The Country Name of the Ship From address.
Result / ShipFromPhone	String	The phone number of the sender if specified.
Result / ShipFromEmail	String	The contact email address of the sender if specified.
Result / TariffPaymentParty	String	Specified value if provided.
Result / ExportReason	String	Specified value if provided.
Result / DeliveryIncoterms	String	Specified value if provided.
Result / CurrencyCode	String	Specified 3 characters currency code for the price specified in your request.
Result / OrderDate	DateTime	The original date & time when the order was placed, specified in your request.
Result / UploadTime	DateTime	The date and time when the order is created into Best Inc. system. Value is based on UTC time zone.
Result / UpdateTime	DateTime	The date and time when the order is updated latest. Value is based on UTC time zone.
Result / WmsTransactionNumber	String	An unique number to identify this order in Best Inc. warehouse.
Result / MasterTrackingNumber	String	The available Tracking Number for shipped packages.
Result / CloseTime	DateTime	The time when the order is shipped out from Best Inc. warehouse. Value is based on UTC time zone.
Result / Items	Array<Object>	The original item list in the order, only return this node when proper value is specified in “DetailOption” parameter. Below are all available nodes: • itemNumber • quantity • unitPrice • countryOfOrigin • hsCode • boxCode • retailSKU • retailDescription • unitCost The ItemNumber will be unique for each line under this node.
Result / ShippedItems	Array<Object>	The actually shipped item list in the order, only return this node when proper value is specified in “DetailOption” parameter, and order status is Shipped. Below are all available nodes: • itemNumber • condition. The actual condition of item that is shipped from warehouse. • shippedQuantity. Actually shipped quantity. • batchNumber. The Batch Number value that is collected in warehouse when ship out the sku. This node will disappear if it’s not collected. • mfgDate. The Manufactured Date value that is collected in warehouse when ship out the sku. This node will disappear if it’s not collected. • expDate. The Expiration Date value that is collected in warehouse when ship out the sku. This node will disappear if it’s not collected. • countryOfOrigin. The Country of Origin value that is collected in warehouse when ship out the sku. This node will disappear if it’s not collected.
Result / Packages	Array<Object>	The package list in the order, only return this node when proper value is specified in “DetailOption” parameter, and the node content is only available when package information is generated in Best warehouse, usually for orders under Pack, Routing, Packed and Shipped status.
Result / Pallets	Array<Object>	The pallet list in the order, only return this node when proper value is specified in “DetailOption” parameter, and the node content is only available when package information is generated in Best warehouse, usually for freight orders under Pack, Routing, Packed and Shipped status.

Response Example

{
    "totalCount": 19,
    "pageNumber": 1,
    "pageSize": 2,
    "pageCount": 10,
    "result": [
        
    "totalCount": 1,
    "pageNumber": 1,
    "pageSize": 15,
    "pageCount": 1,
    "result": [
        {
            "id": "64528-171585",
            "customerCode": "USSAND",
            "orderNumber": "API-test-001",
            "warehouseCode": "USCA01",
            "wmsTransactionNumber": "ST01248044",
            "status": "DueOut", 
            "customerOrderType": "Standard",
            "warehouseNotes": "Testing order", 
            "importChannel": "API", 
            "poNumber": "P233677",
            "shipToName": "John Doe",
            "shipToCompany": "Best Inc.",
            "shipToStreetLine1": "5125 Schaefer Ave",
            "shipToStreetLine2": "STE 101",
            "shipToCity": "Chino",
            "shipToState": "CA",
            "shipToZip": "91710",
            "shipToCountry": "US",
            "shipToPhone": "626-626-7665",
            "shipToEmail": "johnD@testemail.com",
            "shipToIsResidential": false,
            "optionSignature": "Required",
            "carrierServiceLevel": "Ground",
            "carrier": "FEDEX",
            "carrierService": "FEDEX_GROUND",
            "carrierServiceText": "Ground",
            "carrierBillingType": "Sender",
            "orderDate": "2021-09-28T00:00:00+00:00",
            "uploadTime": "2021-09-28T22:57:58+00:00",
            "updateTime": "2021-09-28T22:58:06+00:00",
            "currencyCode": "USD",
            "shippingType": "Parcel",
            "documentCount": 1,
            "items": [
                {
                    "itemId": 69730,
                    "itemNumber": "A002",
                    "itemDescription": "TEST ITEM",
                    "itemKitType": "Component",
                    "quantity": 1,
                    "price": 25.99,
                    "countryOfOrigin": "US",
                    "hsCode": "496693",
                    "boxCode": "",
                    "components": []
                },
                {
                    "itemId": 69729,
                    "itemNumber": "A001",
                    "itemDescription": "TEST ITEM",
                    "itemKitType": "Component",
                    "quantity": 2,
                    "price": 15.99,
                    "countryOfOrigin": "US",
                    "hsCode": "457733",
                    "boxCode": "",
                    "components": []
                }
            ],
            "packages": [],
            "shippedItems": [],
            "pallets": [],
            "changes": [
                {
                    "actionType": "Release",
                    "userId": "N/A",
                    "createdDate": "2021-09-28T22:58:06",
                    "details": [
                        {
                            "fieldName": "Status",
                            "fromValue": "Releasing",
                            "toValue": "Open"
                        }
                    ]
                }
            ]
        }
    ]
}