GET salesorder/detail/{customerNumber}/{salesOrderNumber}?excludeSerialTracking={excludeSerialTracking}
Sales Order Detail - returns details about an order including serial and tracking numbers
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
customerNumber |
Your Customer Number |
string |
Required |
salesOrderNumber |
Sales Order Number |
string |
Required |
excludeSerialTracking |
Optional flag to exclude serial/Tracking #s in detail response |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
SalesOrder
SalesOrderName | Description | Type | Additional information |
---|---|---|---|
SalesOrderNumber |
Sales Order Number |
string |
None. |
BillingAddress |
Billing Address |
Address |
None. |
ShippingAddress |
Shipping Address |
Address |
None. |
PONumber |
Purchase Order Number |
string |
None. |
EndUserPO |
End User Purchase Order Number |
string |
None. |
ReferenceNumber |
ReferenceNumber |
string |
None. |
DocType |
Document Type |
string |
None. |
Status |
Order Status |
string |
None. |
LastShipDate | date |
None. |
|
Memo |
Memo |
string |
None. |
SalesRepCode |
SalesRepCode |
string |
None. |
SalesRepName |
SalesRepName |
string |
None. |
SalesRepEmail |
SalesRepEmail |
string |
None. |
InsuranceAmount |
Insurance Amount |
decimal number |
Data type: Currency |
TaxAmount |
Tax Amount |
decimal number |
Data type: Currency |
Total |
Total Order Amount |
decimal number |
Data type: Currency |
Currency |
Currency code for amounts. USD – US Dollars, CAD- Canadian Dollars, EUR- Euro, GBP- British Pound |
string |
None. |
EnteredByEmail |
email address of user that create order if specified |
string |
None. |
ShippingOptionDescription |
Shipping option description |
string |
None. |
FreightAmount |
Freight amount |
decimal number |
Data type: Currency |
SalesOrderLines |
List of lines |
Collection of SalesOrderLine |
None. |
InvoiceNumbers |
List of invoices for this order |
Collection of string |
None. |
TrackingNumbers |
List of tracking numbers for this order |
Collection of string |
None. |
Deliveries |
List of deliveries for this order |
Collection of Delivery |
None. |
Response Formats
application/json, text/json
{ "SalesOrderNumber": "sample string 1", "BillingAddress": { "Name": "sample string 1", "Attn": "sample string 2", "Street1": "sample string 3", "Street2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "PostalCode": "sample string 7", "Country": "sample string 8" }, "ShippingAddress": { "Name": "sample string 1", "Attn": "sample string 2", "Street1": "sample string 3", "Street2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "PostalCode": "sample string 7", "Country": "sample string 8" }, "PONumber": "sample string 2", "EndUserPO": "sample string 3", "ReferenceNumber": "sample string 4", "DocType": "sample string 5", "Status": "sample string 6", "LastShipDate": "2025-01-18T00:14:57.0775655-05:00", "Memo": "sample string 7", "SalesRepCode": "sample string 8", "SalesRepName": "sample string 9", "SalesRepEmail": "sample string 10", "InsuranceAmount": 11.0, "TaxAmount": 12.0, "Total": 13.0, "Currency": "sample string 14", "EnteredByEmail": "sample string 15", "ShippingOptionDescription": "sample string 16", "FreightAmount": 17.0, "SalesOrderLines": [ { "LineNumber": 1.0, "POLineNumber": 2.0, "ReferenceLineNumber": "sample string 3", "ItemNumber": "sample string 4", "ProductMfrPart": "sample string 5", "CustomerPartNumber": "sample string 6", "CustomerPartReference": "sample string 7", "ProductDescription": "sample string 8", "ItemCatCode": "sample string 9", "ItemCatDesc": "sample string 10", "MatlGrpCode": "sample string 11", "MatlGrpDesc": "sample string 12", "Ordered": 13.0, "Committed": 14.0, "BackOrdered": 15.0, "Shipped": 16.0, "Canceled": 17, "RejectReason": "sample string 18", "Price": 19.0, "Currency": "sample string 20", "SerialNumbers": [ "sample string 1", "sample string 2" ], "ScheduleLines": [ { "EstimatedShipDate": "2025-01-18T00:14:57.0775655-05:00", "Confirmed": 2 }, { "EstimatedShipDate": "2025-01-18T00:14:57.0775655-05:00", "Confirmed": 2 } ] }, { "LineNumber": 1.0, "POLineNumber": 2.0, "ReferenceLineNumber": "sample string 3", "ItemNumber": "sample string 4", "ProductMfrPart": "sample string 5", "CustomerPartNumber": "sample string 6", "CustomerPartReference": "sample string 7", "ProductDescription": "sample string 8", "ItemCatCode": "sample string 9", "ItemCatDesc": "sample string 10", "MatlGrpCode": "sample string 11", "MatlGrpDesc": "sample string 12", "Ordered": 13.0, "Committed": 14.0, "BackOrdered": 15.0, "Shipped": 16.0, "Canceled": 17, "RejectReason": "sample string 18", "Price": 19.0, "Currency": "sample string 20", "SerialNumbers": [ "sample string 1", "sample string 2" ], "ScheduleLines": [ { "EstimatedShipDate": "2025-01-18T00:14:57.0775655-05:00", "Confirmed": 2 }, { "EstimatedShipDate": "2025-01-18T00:14:57.0775655-05:00", "Confirmed": 2 } ] } ], "InvoiceNumbers": [ "sample string 1", "sample string 2" ], "TrackingNumbers": [ "sample string 1", "sample string 2" ], "Deliveries": [ { "DeliveryDocumentNumber": "sample string 1", "DeliveryStatus": "sample string 2", "Parcels": [ { "CartonNumber": "sample string 1", "CarrierCode": "sample string 2", "TrackingType": "sample string 3", "TrackingNumber": "sample string 4", "Weight": 5.0, "WeightUOM": "sample string 6" }, { "CartonNumber": "sample string 1", "CarrierCode": "sample string 2", "TrackingType": "sample string 3", "TrackingNumber": "sample string 4", "Weight": 5.0, "WeightUOM": "sample string 6" } ], "LineItems": [ { "DeliveryDocumentLineNumber": 1, "OrderLineNumber": 2, "ItemNumber": "sample string 3", "QuantityOrdered": 4, "QuantityPicked": 5, "QuantityScanned": 6, "QuantityShipped": 7, "QuantityCanceled": 8, "LineItemDetails": [ { "CartonNumber": "sample string 1", "SerialNumber": "sample string 2", "MACAddress": "sample string 3", "MACAddressUnformatted": "samplestring3" }, { "CartonNumber": "sample string 1", "SerialNumber": "sample string 2", "MACAddress": "sample string 3", "MACAddressUnformatted": "samplestring3" } ] }, { "DeliveryDocumentLineNumber": 1, "OrderLineNumber": 2, "ItemNumber": "sample string 3", "QuantityOrdered": 4, "QuantityPicked": 5, "QuantityScanned": 6, "QuantityShipped": 7, "QuantityCanceled": 8, "LineItemDetails": [ { "CartonNumber": "sample string 1", "SerialNumber": "sample string 2", "MACAddress": "sample string 3", "MACAddressUnformatted": "samplestring3" }, { "CartonNumber": "sample string 1", "SerialNumber": "sample string 2", "MACAddress": "sample string 3", "MACAddressUnformatted": "samplestring3" } ] } ], "ShippedDate": "2025-01-18T00:14:57.0775655-05:00" }, { "DeliveryDocumentNumber": "sample string 1", "DeliveryStatus": "sample string 2", "Parcels": [ { "CartonNumber": "sample string 1", "CarrierCode": "sample string 2", "TrackingType": "sample string 3", "TrackingNumber": "sample string 4", "Weight": 5.0, "WeightUOM": "sample string 6" }, { "CartonNumber": "sample string 1", "CarrierCode": "sample string 2", "TrackingType": "sample string 3", "TrackingNumber": "sample string 4", "Weight": 5.0, "WeightUOM": "sample string 6" } ], "LineItems": [ { "DeliveryDocumentLineNumber": 1, "OrderLineNumber": 2, "ItemNumber": "sample string 3", "QuantityOrdered": 4, "QuantityPicked": 5, "QuantityScanned": 6, "QuantityShipped": 7, "QuantityCanceled": 8, "LineItemDetails": [ { "CartonNumber": "sample string 1", "SerialNumber": "sample string 2", "MACAddress": "sample string 3", "MACAddressUnformatted": "samplestring3" }, { "CartonNumber": "sample string 1", "SerialNumber": "sample string 2", "MACAddress": "sample string 3", "MACAddressUnformatted": "samplestring3" } ] }, { "DeliveryDocumentLineNumber": 1, "OrderLineNumber": 2, "ItemNumber": "sample string 3", "QuantityOrdered": 4, "QuantityPicked": 5, "QuantityScanned": 6, "QuantityShipped": 7, "QuantityCanceled": 8, "LineItemDetails": [ { "CartonNumber": "sample string 1", "SerialNumber": "sample string 2", "MACAddress": "sample string 3", "MACAddressUnformatted": "samplestring3" }, { "CartonNumber": "sample string 1", "SerialNumber": "sample string 2", "MACAddress": "sample string 3", "MACAddressUnformatted": "samplestring3" } ] } ], "ShippedDate": "2025-01-18T00:14:57.0775655-05:00" } ] }
application/xml, text/xml
<SalesOrder xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SalesOrderNumber>sample string 1</SalesOrderNumber> <BillingAddress> <Name>sample string 1</Name> <Attn>sample string 2</Attn> <Street1>sample string 3</Street1> <Street2>sample string 4</Street2> <City>sample string 5</City> <State>sample string 6</State> <PostalCode>sample string 7</PostalCode> <Country>sample string 8</Country> </BillingAddress> <ShippingAddress> <Name>sample string 1</Name> <Attn>sample string 2</Attn> <Street1>sample string 3</Street1> <Street2>sample string 4</Street2> <City>sample string 5</City> <State>sample string 6</State> <PostalCode>sample string 7</PostalCode> <Country>sample string 8</Country> </ShippingAddress> <PONumber>sample string 2</PONumber> <EndUserPO>sample string 3</EndUserPO> <ReferenceNumber>sample string 4</ReferenceNumber> <DocType>sample string 5</DocType> <Status>sample string 6</Status> <LastShipDate>2025-01-18T00:14:57.0775655-05:00</LastShipDate> <Memo>sample string 7</Memo> <SalesRepCode>sample string 8</SalesRepCode> <SalesRepName>sample string 9</SalesRepName> <SalesRepEmail>sample string 10</SalesRepEmail> <InsuranceAmount>11</InsuranceAmount> <TaxAmount>12</TaxAmount> <Total>13</Total> <Currency>sample string 14</Currency> <EnteredByEmail>sample string 15</EnteredByEmail> <ShippingOptionDescription>sample string 16</ShippingOptionDescription> <FreightAmount>17</FreightAmount> <SalesOrderLines> <SalesOrderLine> <LineNumber>1</LineNumber> <POLineNumber>2</POLineNumber> <ReferenceLineNumber>sample string 3</ReferenceLineNumber> <ItemNumber>sample string 4</ItemNumber> <ProductMfrPart>sample string 5</ProductMfrPart> <CustomerPartNumber>sample string 6</CustomerPartNumber> <CustomerPartReference>sample string 7</CustomerPartReference> <ProductDescription>sample string 8</ProductDescription> <ItemCatCode>sample string 9</ItemCatCode> <ItemCatDesc>sample string 10</ItemCatDesc> <MatlGrpCode>sample string 11</MatlGrpCode> <MatlGrpDesc>sample string 12</MatlGrpDesc> <Ordered>13</Ordered> <Committed>14</Committed> <BackOrdered>15</BackOrdered> <Shipped>16</Shipped> <Canceled>17</Canceled> <RejectReason>sample string 18</RejectReason> <Price>19</Price> <Currency>sample string 20</Currency> <SerialNumbers> <string>sample string 1</string> <string>sample string 2</string> </SerialNumbers> <ScheduleLines> <ScheduleLine> <EstimatedShipDate>2025-01-18T00:14:57.0775655-05:00</EstimatedShipDate> <Confirmed>2</Confirmed> </ScheduleLine> <ScheduleLine> <EstimatedShipDate>2025-01-18T00:14:57.0775655-05:00</EstimatedShipDate> <Confirmed>2</Confirmed> </ScheduleLine> </ScheduleLines> </SalesOrderLine> <SalesOrderLine> <LineNumber>1</LineNumber> <POLineNumber>2</POLineNumber> <ReferenceLineNumber>sample string 3</ReferenceLineNumber> <ItemNumber>sample string 4</ItemNumber> <ProductMfrPart>sample string 5</ProductMfrPart> <CustomerPartNumber>sample string 6</CustomerPartNumber> <CustomerPartReference>sample string 7</CustomerPartReference> <ProductDescription>sample string 8</ProductDescription> <ItemCatCode>sample string 9</ItemCatCode> <ItemCatDesc>sample string 10</ItemCatDesc> <MatlGrpCode>sample string 11</MatlGrpCode> <MatlGrpDesc>sample string 12</MatlGrpDesc> <Ordered>13</Ordered> <Committed>14</Committed> <BackOrdered>15</BackOrdered> <Shipped>16</Shipped> <Canceled>17</Canceled> <RejectReason>sample string 18</RejectReason> <Price>19</Price> <Currency>sample string 20</Currency> <SerialNumbers> <string>sample string 1</string> <string>sample string 2</string> </SerialNumbers> <ScheduleLines> <ScheduleLine> <EstimatedShipDate>2025-01-18T00:14:57.0775655-05:00</EstimatedShipDate> <Confirmed>2</Confirmed> </ScheduleLine> <ScheduleLine> <EstimatedShipDate>2025-01-18T00:14:57.0775655-05:00</EstimatedShipDate> <Confirmed>2</Confirmed> </ScheduleLine> </ScheduleLines> </SalesOrderLine> </SalesOrderLines> <InvoiceNumbers> <string>sample string 1</string> <string>sample string 2</string> </InvoiceNumbers> <TrackingNumbers> <string>sample string 1</string> <string>sample string 2</string> </TrackingNumbers> <Deliveries> <Delivery> <DeliveryDocumentNumber>sample string 1</DeliveryDocumentNumber> <DeliveryStatus>sample string 2</DeliveryStatus> <Parcels> <DeliveryParcel> <CartonNumber>sample string 1</CartonNumber> <CarrierCode>sample string 2</CarrierCode> <TrackingType>sample string 3</TrackingType> <TrackingNumber>sample string 4</TrackingNumber> <Weight>5</Weight> <WeightUOM>sample string 6</WeightUOM> </DeliveryParcel> <DeliveryParcel> <CartonNumber>sample string 1</CartonNumber> <CarrierCode>sample string 2</CarrierCode> <TrackingType>sample string 3</TrackingType> <TrackingNumber>sample string 4</TrackingNumber> <Weight>5</Weight> <WeightUOM>sample string 6</WeightUOM> </DeliveryParcel> </Parcels> <LineItems> <DeliveryLineItem> <DeliveryDocumentLineNumber>1</DeliveryDocumentLineNumber> <OrderLineNumber>2</OrderLineNumber> <ItemNumber>sample string 3</ItemNumber> <QuantityOrdered>4</QuantityOrdered> <QuantityPicked>5</QuantityPicked> <QuantityScanned>6</QuantityScanned> <QuantityShipped>7</QuantityShipped> <QuantityCanceled>8</QuantityCanceled> <LineItemDetails> <DeliveryLineItemDetail> <CartonNumber>sample string 1</CartonNumber> <SerialNumber>sample string 2</SerialNumber> <MACAddress>sample string 3</MACAddress> </DeliveryLineItemDetail> <DeliveryLineItemDetail> <CartonNumber>sample string 1</CartonNumber> <SerialNumber>sample string 2</SerialNumber> <MACAddress>sample string 3</MACAddress> </DeliveryLineItemDetail> </LineItemDetails> </DeliveryLineItem> <DeliveryLineItem> <DeliveryDocumentLineNumber>1</DeliveryDocumentLineNumber> <OrderLineNumber>2</OrderLineNumber> <ItemNumber>sample string 3</ItemNumber> <QuantityOrdered>4</QuantityOrdered> <QuantityPicked>5</QuantityPicked> <QuantityScanned>6</QuantityScanned> <QuantityShipped>7</QuantityShipped> <QuantityCanceled>8</QuantityCanceled> <LineItemDetails> <DeliveryLineItemDetail> <CartonNumber>sample string 1</CartonNumber> <SerialNumber>sample string 2</SerialNumber> <MACAddress>sample string 3</MACAddress> </DeliveryLineItemDetail> <DeliveryLineItemDetail> <CartonNumber>sample string 1</CartonNumber> <SerialNumber>sample string 2</SerialNumber> <MACAddress>sample string 3</MACAddress> </DeliveryLineItemDetail> </LineItemDetails> </DeliveryLineItem> </LineItems> <ShippedDate>2025-01-18T00:14:57.0775655-05:00</ShippedDate> </Delivery> <Delivery> <DeliveryDocumentNumber>sample string 1</DeliveryDocumentNumber> <DeliveryStatus>sample string 2</DeliveryStatus> <Parcels> <DeliveryParcel> <CartonNumber>sample string 1</CartonNumber> <CarrierCode>sample string 2</CarrierCode> <TrackingType>sample string 3</TrackingType> <TrackingNumber>sample string 4</TrackingNumber> <Weight>5</Weight> <WeightUOM>sample string 6</WeightUOM> </DeliveryParcel> <DeliveryParcel> <CartonNumber>sample string 1</CartonNumber> <CarrierCode>sample string 2</CarrierCode> <TrackingType>sample string 3</TrackingType> <TrackingNumber>sample string 4</TrackingNumber> <Weight>5</Weight> <WeightUOM>sample string 6</WeightUOM> </DeliveryParcel> </Parcels> <LineItems> <DeliveryLineItem> <DeliveryDocumentLineNumber>1</DeliveryDocumentLineNumber> <OrderLineNumber>2</OrderLineNumber> <ItemNumber>sample string 3</ItemNumber> <QuantityOrdered>4</QuantityOrdered> <QuantityPicked>5</QuantityPicked> <QuantityScanned>6</QuantityScanned> <QuantityShipped>7</QuantityShipped> <QuantityCanceled>8</QuantityCanceled> <LineItemDetails> <DeliveryLineItemDetail> <CartonNumber>sample string 1</CartonNumber> <SerialNumber>sample string 2</SerialNumber> <MACAddress>sample string 3</MACAddress> </DeliveryLineItemDetail> <DeliveryLineItemDetail> <CartonNumber>sample string 1</CartonNumber> <SerialNumber>sample string 2</SerialNumber> <MACAddress>sample string 3</MACAddress> </DeliveryLineItemDetail> </LineItemDetails> </DeliveryLineItem> <DeliveryLineItem> <DeliveryDocumentLineNumber>1</DeliveryDocumentLineNumber> <OrderLineNumber>2</OrderLineNumber> <ItemNumber>sample string 3</ItemNumber> <QuantityOrdered>4</QuantityOrdered> <QuantityPicked>5</QuantityPicked> <QuantityScanned>6</QuantityScanned> <QuantityShipped>7</QuantityShipped> <QuantityCanceled>8</QuantityCanceled> <LineItemDetails> <DeliveryLineItemDetail> <CartonNumber>sample string 1</CartonNumber> <SerialNumber>sample string 2</SerialNumber> <MACAddress>sample string 3</MACAddress> </DeliveryLineItemDetail> <DeliveryLineItemDetail> <CartonNumber>sample string 1</CartonNumber> <SerialNumber>sample string 2</SerialNumber> <MACAddress>sample string 3</MACAddress> </DeliveryLineItemDetail> </LineItemDetails> </DeliveryLineItem> </LineItems> <ShippedDate>2025-01-18T00:14:57.0775655-05:00</ShippedDate> </Delivery> </Deliveries> </SalesOrder>