GET api/Order/ById?id={id}&ClientOrderId={ClientOrderId}

Retrieves basic details on a single 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 WMS 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 WMS 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
ClientOrderId2	Alternate identifier from your system.	string	None.
WarehouseCode	Use "SLC" to send the order to the Salt Lake City warehouse. The default is "SLC".	string	None.
OrderStatus	Assigned by WMS 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
Email		string	String length: inclusive between 0 and 100
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, FEDEX_Ground, FEDEX_Home, 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_WorldwideSaver, UPS_WorldwideExpress, USPS_FirstClassInternational, USPS_GroundAdvantage, USPS_PriorityMail, USPS_PriorityMailExpress, USPS_PriorityMailExpressInternational, and USPS_PriorityMailInternational	string	None.
ShippingBillingProfileId	As an option, you can choose which ShippingBillingProfileId to use for the order. These profiles are setup beforehand in the WMS. If no value (or an unknown value) is supplied, then the default profile for the client will be used.	integer	None.
OrderAmount	This is the value of the order which is used for international customs. If an integer above '0' is supplied, then the supplied OrderAmount will be used to calculate the item values on the international customs forms. If a value of '0' is supplied, then the order will be marked as a gift with a default customs value of $1.00 per item. If a value of 'null' is supplied, then the OrderAmount will be calculated from the product default values currently stored with ISC.	integer	None.
NotesToCustomerPackingSlip	Text submitted here will appear on the packing slip to the end customer.	string	String length: inclusive between 0 and 500
NotesToWarehouse	Text submitted here will appear on screen when picking an order.	string	String length: inclusive between 0 and 255
OrderDetailData	Includes the product line items for the order.	Collection of OrderDetailData	None.
OrderMetaData	Includes any additional meta data for the order.	Collection of OrderMetaData	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderId": 2,
  "ClientOrderId": "sample string 3",
  "ClientOrderId2": "sample string 4",
  "WarehouseCode": "sample string 6",
  "OrderStatus": "sample string 7",
  "OrderDate": "2026-02-03T13:53:00.0492971+00:00",
  "CompanyOrName": "sample string 10",
  "Attention": "sample string 11",
  "AddressLine1": "sample string 12",
  "AddressLine2": "sample string 13",
  "AddressLine3": "sample string 14",
  "City": "sample string 15",
  "State": "sample string 16",
  "PostalCode": "sample string 17",
  "Country": "sample string 18",
  "Phone": "sample string 19",
  "Email": "sample string 20",
  "ShippingMethod": "sample string 22",
  "ShippingBillingProfileId": 1,
  "OrderAmount": 1,
  "NotesToCustomerPackingSlip": "sample string 23",
  "NotesToWarehouse": "sample string 24",
  "OrderDetailData": [
    {
      "ClientOrderDetailId": "sample string 3",
      "ItemSKU": "sample string 5",
      "ItemSKU2": "sample string 6",
      "ItemDescription": "sample string 7",
      "ItemQuantity": 8,
      "ItemPrice": 9.1,
      "IsKitHeader": true,
      "OrderDetailLotData": [
        {
          "InventoryUnitId": 2,
          "LicenseId": "sample string 3",
          "Lot": "sample string 4",
          "Serial": "sample string 5",
          "ExpirationDate": "2026-02-03T13:53:00.0492971+00:00",
          "ItemQuantity": 6
        },
        {
          "InventoryUnitId": 2,
          "LicenseId": "sample string 3",
          "Lot": "sample string 4",
          "Serial": "sample string 5",
          "ExpirationDate": "2026-02-03T13:53:00.0492971+00:00",
          "ItemQuantity": 6
        }
      ],
      "OrderDetailMetaData": [
        {
          "Key": "sample string 3",
          "Name": "sample string 4",
          "Description": "sample string 5",
          "Value": "sample string 6"
        },
        {
          "Key": "sample string 3",
          "Name": "sample string 4",
          "Description": "sample string 5",
          "Value": "sample string 6"
        }
      ]
    },
    {
      "ClientOrderDetailId": "sample string 3",
      "ItemSKU": "sample string 5",
      "ItemSKU2": "sample string 6",
      "ItemDescription": "sample string 7",
      "ItemQuantity": 8,
      "ItemPrice": 9.1,
      "IsKitHeader": true,
      "OrderDetailLotData": [
        {
          "InventoryUnitId": 2,
          "LicenseId": "sample string 3",
          "Lot": "sample string 4",
          "Serial": "sample string 5",
          "ExpirationDate": "2026-02-03T13:53:00.0492971+00:00",
          "ItemQuantity": 6
        },
        {
          "InventoryUnitId": 2,
          "LicenseId": "sample string 3",
          "Lot": "sample string 4",
          "Serial": "sample string 5",
          "ExpirationDate": "2026-02-03T13:53:00.0492971+00:00",
          "ItemQuantity": 6
        }
      ],
      "OrderDetailMetaData": [
        {
          "Key": "sample string 3",
          "Name": "sample string 4",
          "Description": "sample string 5",
          "Value": "sample string 6"
        },
        {
          "Key": "sample string 3",
          "Name": "sample string 4",
          "Description": "sample string 5",
          "Value": "sample string 6"
        }
      ]
    }
  ],
  "OrderMetaData": [
    {
      "Key": "sample string 3",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Value": "sample string 6"
    },
    {
      "Key": "sample string 3",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Value": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:

<OrderData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ISCAPI2.Models">
  <AddressLine1>sample string 12</AddressLine1>
  <AddressLine2>sample string 13</AddressLine2>
  <AddressLine3>sample string 14</AddressLine3>
  <Attention>sample string 11</Attention>
  <CarrierCode>sample string 21</CarrierCode>
  <City>sample string 15</City>
  <ClientCode>sample string 5</ClientCode>
  <ClientOrderId>sample string 3</ClientOrderId>
  <ClientOrderId2>sample string 4</ClientOrderId2>
  <CompanyOrName>sample string 10</CompanyOrName>
  <Country>sample string 18</Country>
  <Email>sample string 20</Email>
  <ImportDate>2026-02-03T13:53:00.0492971+00:00</ImportDate>
  <NotesToCustomerPackingSlip>sample string 23</NotesToCustomerPackingSlip>
  <NotesToWarehouse>sample string 24</NotesToWarehouse>
  <OrderAmount>1</OrderAmount>
  <OrderDataId>1</OrderDataId>
  <OrderDate>2026-02-03T13:53:00.0492971+00:00</OrderDate>
  <OrderDetailData>
    <OrderDetailData>
      <ClientOrderDetailId>sample string 3</ClientOrderDetailId>
      <IsKitHeader>true</IsKitHeader>
      <ItemDescription>sample string 7</ItemDescription>
      <ItemPrice>9.1</ItemPrice>
      <ItemQuantity>8</ItemQuantity>
      <ItemSKU>sample string 5</ItemSKU>
      <ItemSKU2>sample string 6</ItemSKU2>
      <OrderDetailDataId>1</OrderDetailDataId>
      <OrderDetailId>2</OrderDetailId>
      <OrderDetailLotData>
        <OrderDetailLotData>
          <ExpirationDate>2026-02-03T13:53:00.0492971+00:00</ExpirationDate>
          <InventoryLotId>1</InventoryLotId>
          <InventoryUnitId>2</InventoryUnitId>
          <ItemQuantity>6</ItemQuantity>
          <LicenseId>sample string 3</LicenseId>
          <Lot>sample string 4</Lot>
          <MultiLotId>1</MultiLotId>
          <OrderDetailLotDataId>1</OrderDetailLotDataId>
          <Serial>sample string 5</Serial>
        </OrderDetailLotData>
        <OrderDetailLotData>
          <ExpirationDate>2026-02-03T13:53:00.0492971+00:00</ExpirationDate>
          <InventoryLotId>1</InventoryLotId>
          <InventoryUnitId>2</InventoryUnitId>
          <ItemQuantity>6</ItemQuantity>
          <LicenseId>sample string 3</LicenseId>
          <Lot>sample string 4</Lot>
          <MultiLotId>1</MultiLotId>
          <OrderDetailLotDataId>1</OrderDetailLotDataId>
          <Serial>sample string 5</Serial>
        </OrderDetailLotData>
      </OrderDetailLotData>
      <OrderDetailMetaData>
        <OrderDetailMetaData>
          <Description>sample string 5</Description>
          <Key>sample string 3</Key>
          <ModuleId>2</ModuleId>
          <Name>sample string 4</Name>
          <OrderDetailMetaDataId>1</OrderDetailMetaDataId>
          <OrderDetailTokenId>1</OrderDetailTokenId>
          <Value>sample string 6</Value>
        </OrderDetailMetaData>
        <OrderDetailMetaData>
          <Description>sample string 5</Description>
          <Key>sample string 3</Key>
          <ModuleId>2</ModuleId>
          <Name>sample string 4</Name>
          <OrderDetailMetaDataId>1</OrderDetailMetaDataId>
          <OrderDetailTokenId>1</OrderDetailTokenId>
          <Value>sample string 6</Value>
        </OrderDetailMetaData>
      </OrderDetailMetaData>
      <OrderId>4</OrderId>
    </OrderDetailData>
    <OrderDetailData>
      <ClientOrderDetailId>sample string 3</ClientOrderDetailId>
      <IsKitHeader>true</IsKitHeader>
      <ItemDescription>sample string 7</ItemDescription>
      <ItemPrice>9.1</ItemPrice>
      <ItemQuantity>8</ItemQuantity>
      <ItemSKU>sample string 5</ItemSKU>
      <ItemSKU2>sample string 6</ItemSKU2>
      <OrderDetailDataId>1</OrderDetailDataId>
      <OrderDetailId>2</OrderDetailId>
      <OrderDetailLotData>
        <OrderDetailLotData>
          <ExpirationDate>2026-02-03T13:53:00.0492971+00:00</ExpirationDate>
          <InventoryLotId>1</InventoryLotId>
          <InventoryUnitId>2</InventoryUnitId>
          <ItemQuantity>6</ItemQuantity>
          <LicenseId>sample string 3</LicenseId>
          <Lot>sample string 4</Lot>
          <MultiLotId>1</MultiLotId>
          <OrderDetailLotDataId>1</OrderDetailLotDataId>
          <Serial>sample string 5</Serial>
        </OrderDetailLotData>
        <OrderDetailLotData>
          <ExpirationDate>2026-02-03T13:53:00.0492971+00:00</ExpirationDate>
          <InventoryLotId>1</InventoryLotId>
          <InventoryUnitId>2</InventoryUnitId>
          <ItemQuantity>6</ItemQuantity>
          <LicenseId>sample string 3</LicenseId>
          <Lot>sample string 4</Lot>
          <MultiLotId>1</MultiLotId>
          <OrderDetailLotDataId>1</OrderDetailLotDataId>
          <Serial>sample string 5</Serial>
        </OrderDetailLotData>
      </OrderDetailLotData>
      <OrderDetailMetaData>
        <OrderDetailMetaData>
          <Description>sample string 5</Description>
          <Key>sample string 3</Key>
          <ModuleId>2</ModuleId>
          <Name>sample string 4</Name>
          <OrderDetailMetaDataId>1</OrderDetailMetaDataId>
          <OrderDetailTokenId>1</OrderDetailTokenId>
          <Value>sample string 6</Value>
        </OrderDetailMetaData>
        <OrderDetailMetaData>
          <Description>sample string 5</Description>
          <Key>sample string 3</Key>
          <ModuleId>2</ModuleId>
          <Name>sample string 4</Name>
          <OrderDetailMetaDataId>1</OrderDetailMetaDataId>
          <OrderDetailTokenId>1</OrderDetailTokenId>
          <Value>sample string 6</Value>
        </OrderDetailMetaData>
      </OrderDetailMetaData>
      <OrderId>4</OrderId>
    </OrderDetailData>
  </OrderDetailData>
  <OrderId>2</OrderId>
  <OrderMetaData>
    <OrderMetaData>
      <Description>sample string 5</Description>
      <Key>sample string 3</Key>
      <ModuleId>2</ModuleId>
      <Name>sample string 4</Name>
      <OrderMetaDataId>1</OrderMetaDataId>
      <OrderTokenId>1</OrderTokenId>
      <Value>sample string 6</Value>
    </OrderMetaData>
    <OrderMetaData>
      <Description>sample string 5</Description>
      <Key>sample string 3</Key>
      <ModuleId>2</ModuleId>
      <Name>sample string 4</Name>
      <OrderMetaDataId>1</OrderMetaDataId>
      <OrderTokenId>1</OrderTokenId>
      <Value>sample string 6</Value>
    </OrderMetaData>
  </OrderMetaData>
  <OrderStatus>sample string 7</OrderStatus>
  <Phone>sample string 19</Phone>
  <PostalCode>sample string 17</PostalCode>
  <ShippingBillingProfileId>1</ShippingBillingProfileId>
  <ShippingMethod>sample string 22</ShippingMethod>
  <State>sample string 16</State>
  <WarehouseCode>sample string 6</WarehouseCode>
</OrderData>