GET api/Order/ById?id={id}&ClientOrderId={ClientOrderId}
Retrieves full details on an order by order number.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Only one of these parameters are required. The id is the int OrderId in the ASAP system. |
integer |
None. |
| ClientOrderId |
Only one of these parameters are required. This is the string ClientOrderId from your system. |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
OrderData| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderId |
Unique identifier from the ASAP system that is assigned at order creation, and it can be used as the id parameter. |
integer |
None. |
| ClientOrderId |
Unique order identifier from your system. |
string |
Required String length: inclusive between 1 and 100 |
| WarehouseCode |
Use warehouse code to send the outbound order to the appropriate warehouse. The default is "SLC". Possible values are: SLC (for LogiTrans SLC 1), EMP (for Logitrans SLC 2), PVU (for SLC ASAP Warehouse), LAX (for LAX ASAP Warehouse) |
string |
None. |
| OrderStatus |
Assigned by ASAP to show the current status of the order. |
string |
None. |
| OrderDate | date |
Required |
|
| CompanyOrName | string |
Required String length: inclusive between 2 and 35 |
|
| Attention | string |
String length: inclusive between 2 and 35 |
|
| AddressLine1 | string |
Required String length: inclusive between 2 and 35 |
|
| AddressLine2 | string |
String length: inclusive between 2 and 35 |
|
| AddressLine3 | string |
String length: inclusive between 2 and 35 |
|
| City | string |
Required String length: inclusive between 2 and 35 |
|
| State |
Can accept the 2 digit state code or the state's full name. |
string |
Required String length: inclusive between 2 and 35 |
| PostalCode | string |
Required String length: inclusive between 2 and 35 |
|
| Country |
Can accept the 2 digit ISO code, the 3 digit ISO code, or the country's full name. |
string |
Required String length: inclusive between 2 and 35 |
| Phone | string |
String length: inclusive between 0 and 35 |
|
| ShippingMethod |
If no ShippingMethod is submitted the default will be ISC_Economy (lowest cost option). The current acceptable values are: ISC_Economy, ISC_Freight, ISC_WillCall, UPS_2ndDayAir, UPS_2ndDayAirAM, UPS_3DaySelect, UPS_Ground, UPS_GroundCommercial, UPS_GroundResidential, UPS_MailInnovations, UPS_NextDayAir, UPS_NextDayAirEarlyAM, UPS_NextDayAirSaver, UPS_StandardtoCanada, UPS_SurePost, UPS_WorldwideExpedited, UPS_WorldwideExpress, USPS_FirstClass, USPS_FirstClassInternational, USPS_PriorityMail, USPS_PriorityMailExpress, USPS_PriorityMailExpressInternational, and USPS_PriorityMailInternational |
string |
None. |
| NotesToCustomerPackingSlip |
Text submitted here will appear on the packing slip to the end customer. |
string |
String length: inclusive between 0 and 500 |
| OrderDetailData | Collection of OrderDetailData |
None. |
Response Formats
application/json, text/json
{
"OrderId": 2,
"ClientOrderId": "sample string 3",
"WarehouseCode": "sample string 5",
"OrderStatus": "sample string 6",
"OrderDate": "2026-06-11T02:43:11.3002869+00:00",
"CompanyOrName": "sample string 9",
"Attention": "sample string 10",
"AddressLine1": "sample string 11",
"AddressLine2": "sample string 12",
"AddressLine3": "sample string 13",
"City": "sample string 14",
"State": "sample string 15",
"PostalCode": "sample string 16",
"Country": "sample string 17",
"Phone": "sample string 18",
"ShippingMethod": "sample string 20",
"NotesToCustomerPackingSlip": "sample string 21",
"OrderDetailData": [
{
"ItemSKU": "sample string 4",
"ItemDescription": "sample string 5",
"ItemQuantity": 6
},
{
"ItemSKU": "sample string 4",
"ItemDescription": "sample string 5",
"ItemQuantity": 6
}
]
}
application/xml, text/xml
<OrderData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ISCLGTAPI.Models">
<AddressLine1>sample string 11</AddressLine1>
<AddressLine2>sample string 12</AddressLine2>
<AddressLine3>sample string 13</AddressLine3>
<Attention>sample string 10</Attention>
<CarrierCode>sample string 19</CarrierCode>
<City>sample string 14</City>
<ClientCode>sample string 4</ClientCode>
<ClientOrderId>sample string 3</ClientOrderId>
<CompanyOrName>sample string 9</CompanyOrName>
<Country>sample string 17</Country>
<ImportDate>2026-06-11T02:43:11.3002869+00:00</ImportDate>
<NotesToCustomerPackingSlip>sample string 21</NotesToCustomerPackingSlip>
<OrderDataId>1</OrderDataId>
<OrderDate>2026-06-11T02:43:11.3002869+00:00</OrderDate>
<OrderDetailData>
<OrderDetailData>
<ItemDescription>sample string 5</ItemDescription>
<ItemQuantity>6</ItemQuantity>
<ItemSKU>sample string 4</ItemSKU>
<OrderDetailDataId>1</OrderDetailDataId>
<OrderDetailId>2</OrderDetailId>
<OrderId>3</OrderId>
</OrderDetailData>
<OrderDetailData>
<ItemDescription>sample string 5</ItemDescription>
<ItemQuantity>6</ItemQuantity>
<ItemSKU>sample string 4</ItemSKU>
<OrderDetailDataId>1</OrderDetailDataId>
<OrderDetailId>2</OrderDetailId>
<OrderId>3</OrderId>
</OrderDetailData>
</OrderDetailData>
<OrderId>2</OrderId>
<OrderStatus>sample string 6</OrderStatus>
<Phone>sample string 18</Phone>
<PostalCode>sample string 16</PostalCode>
<ShippingMethod>sample string 20</ShippingMethod>
<State>sample string 15</State>
<WarehouseCode>sample string 5</WarehouseCode>
</OrderData>