Order API
Order materials and track orders and deliveries within your system. Retrieve order details and the status of upcoming deliveries to keep your team on track and your customers informed in real time.
The Get Order endpoint returns an entire order previously submitted through the ABC API. The response includes account numbers, dates, delivery appointments, pricing, product line items and comments.
order API
Get Order
GET /orders
Get all order information
Sandbox
Production
Authorization
For Individuals and Businesses, use OAuth 2.0 server or user token with the order.read scope.
For Third-Party Aggregators, use OAuth 2.0 user token with the order.read scope.
Request
Get Order by Confirmation Number
Parameter
Value
confirmationNumber
The confirmation number related to a particular order.
Example Request
GET /api/order/v2/orders?confirmationNumber=C7-3838333 HTTP/1.1
Host: partners.abcsupply.com
Authorization: Bearer <TOKEN>Get Order by Order Number
Parameter
Value
orderNumber
The order number related to a particular order.
Example Request
GET /api/order/v2/orders/1030033 HTTP/1.1
Host: partners.abcsupply.com
Authorization: Bearer <TOKEN>Response
Example Response
{
"salesOrder": {
"confirmationNumber": "C7-3838333",
"orderNumber": "10000828",
"purchaseOrder": "PO-123456890",
"createdDate": "2019-12-20",
"orderType": "DELIVERY",
"deliveryService": "ROOFTOP DELIVERY",
"status": "INVOICED",
"currency": "USD"
},
"dates": {
"deliveryRequestedFor": "2019-12-20",
"orderedOn": "2019-12-20"
},
"deliveryAppointment": {
"instructionsTypeCode": "AT",
"instructions": "Please leave in driveway",
"fromTime": "10:00",
"toTime": "11:00",
"timeZoneCode": "CT"
},
"orderAmounts": {
"subTotal": 0,
"tax": 6.99,
"total": 106.83
},
"charges": [
{
"code": "D240",
"description": "Freight",
"amount": 9.09
},
{
"code": "A120",
"description": "Additional Copies of Freight Bill",
"amount": 1.09
}
],
"soldTo": {
"number": "12345678-1",
"name": "ABC CONSTRUCTION",
"links": {
"href": "https://partners.abcsupply.com/api/accounts/v1/soldtos/12345678-1"
}
},
"billTo": {
"number": "456789-1",
"name": "ABC CONSTRUCTION",
"links": {
"href": "https://partners.abcsupply.com/api/accounts/v1/billtos/456789-1"
}
},
"shipTo": {
"number": "12345678-100",
"name": "ABC CONSTRUCTION",
"links": {
"href": "https://partners.abcsupply.com/api/accounts/v1/shiptos/12345678-100"
}
},
"branch": {
"number": "409",
"name": "ABC #409 HYATTSVILLE",
"storefront": "abc",
"links": {
"href": "https://partners.abcsupply.com/api/location/v1/branches/409"
}
},
"lines": [
{
"id": "1",
"itemNumber": "N58XMR",
"links": {
"href": "https://partners.abcsupply.com/api/product/v1/items/N58XMR"
},
"dimensions": {
"length": {
"value": 10,
"uomCode": "ft",
"uom": "Feet"
}
},
"orderedQty": {
"value": 1300,
"uomCode": "PC",
"uom": "Piece"
},
"unitPrice": {
"value": 365.01,
"uomCode": "SQ",
"uom": "Squares"
},
"amount": 1226.4,
"comments": [
{
"code": "L",
"description": "10-27-15- NSF CK#2509 FOR $7127.65. LG"
}
]
}
],
"shipments": [
{
"shipmentNumber": "10000828-1",
"status": "INVOICED",
"total": 106.83,
"dates": {
"deliveryRequestedOn": "2019-12-20",
"deliveredOn": "2019-12-23",
"invoicedOn": "2019-12-23"
},
"address": {
"line1": "123 ABC Dr.",
"line2": "",
"line3": "Bldg. 1 ",
"city": "Greenwood",
"state": "IN",
"postal": "46143",
"country": "USA"
},
"comments": [
{
"code": "O",
"description": "10-27-15- NSF CK#2509 FOR $7127.65. LG"
}
],
"amounts": {
"subTotal": 0,
"tax": 6.99,
"total": 106.83
},
"charges": [
{
"code": "D240",
"description": "Freight",
"amount": 9.09
},
{
"code": "A120",
"description": "Additional Copies of Freight Bill",
"amount": 1.09
}
],
"deliveryHistory": [
{
"name": "Delivery Complete",
"code": "CD",
"ladingException": "",
"notes": "",
"localTime": "2022-08-22T12:15:52.0770000-04:00",
"utcTime": "2022-08-22T16:15:52.0770000Z"
},
{
"name": "Arrived at Delivery Location",
"code": "X1",
"ladingException": "",
"notes": "",
"localTime": "2022-08-22T12:07:11.9570000-04:00",
"utcTime": "2022-08-22T16:07:11.9548511Z"
},
{
"name": "Scheduled",
"code": "AG",
"ladingException": "",
"notes": "",
"localTime": "2022-08-22T12:07:11.9570000-04:00",
"utcTime": "2022-08-22T16:07:11.9548511Z"
},
{
"name": "Arrived at Pick-up location",
"code": "X3",
"ladingException": "",
"notes": "Staged",
"localTime": "2022-08-17T12:08:19.2690000-07:00",
"utcTime": "2022-08-17T19:08:19.2690000Z"
},
{
"name": "Delivery Not Complete",
"code": "AP",
"ladingException": "Partial Shipment",
"notes": "Missing parts",
"localTime": "2022-08-17T12:08:19.2690000-07:00",
"utcTime": "2022-08-17T19:08:19.2690000Z"
},
{
"name": "Entire Shipment Refused",
"code": "A7",
"ladingException": "Shipment Rejected",
"notes": "Customer could not accept the delivery due to scheduling",
"localTime": "2022-08-17T12:08:19.2690000-07:00",
"utcTime": "2022-08-17T19:08:19.2690000Z"
},
{
"name": "Attempted Delivery",
"code": "AH",
"ladingException": "Obstructed",
"notes": "Customer could not accept the delivery due to obstructions",
"localTime": "2022-08-17T12:08:19.2690000-07:00",
"utcTime": "2022-08-17T19:08:19.2690000Z"
},
{
"name": "Shipment Delayed",
"code": "SD",
"ladingException": "Rescheduled",
"notes": "Customer rescheduled the shipment",
"localTime": "2022-08-17T12:08:19.2690000-07:00",
"utcTime": "2022-08-17T19:08:19.2690000Z"
}
],
"lines": [
{
"id": "1",
"itemNumber": "N58XMR",
"links": {
"href": "https://partners.abcsupply.com/api/product/v1/items/N58XMR"
},
"dimensions": {
"length": {
"value": 10,
"uomCode": "ft",
"uom": "Feet"
}
},
"orderedQty": {
"value": 20,
"uomCode": "PC",
"uom": "Pieces"
},
"unitPrice": {
"value": 365.01,
"uomCode": "SQ",
"uom": "Squares"
},
"amount": 1226.4,
"comments": [
{
"code": "L",
"description": "10-27-15- NSF CK#2509 FOR $7127.65. LG"
}
]
}
]
}
]
}Name
Type
Description
salesOrder
object
The object describing the sales order information.
salesOrder.confirmationNumber
string
The confirmation number of the sales order.
salesOrder.orderNumber
string
The order number internal to the sales order system.
salesOrder.purchaseOrder
string
The purchase order related to the sales order.
salesOrder.createdDate
string
The date the sales order was created (e.g., "2019-12-20").
salesOrder.orderType
string
The type of sales order (e.g., “DELIVERY”).
salesOrder.deliveryService
string
The type of delivery service for the order (e.g., “COM”: Common Carrier, “CPU”: Customer Pickup, “EXP”: Express Pickup, “OTR”: Our Truck Roof, “OTG”: Our Truck Ground, “OTW”: Our Truck Window, “TPC”: Third-Party Carrier).
salesOrder.status
string
The status of the sales order (e.g., “INVOICED”).
dates
object
The object describing the requested date of delivery.
dates.deliveryRequestedFor
string
The date the delivery is requested for (“YYYY-MM-DD”).
dates.orderedOn
string
The date the order is requested for (“YYYY-MM-DD”).
deliveryAppointment
object
The object that describes the delivery appointment information.
deliveryAppointment.instructionsTypeCode
string
The delivery type (e.g., “AT”: Anytime Delivery).
deliveryAppointment.instructions
string
The text of the delivery instructions.
deliveryAppointment.fromTime
string
The earliest point of scheduled delivery in military time.
deliveryAppointment.toTime
string
The latest point of scheduled delivery in military time.
deliveryAppointment.timeZoneCode
string
The two-letter time zone code.
orderAmounts
object
The object describing the order amounts for the order.
orderAmounts.subTotal
float
The subtotal of the order.
orderAmounts.tax
float
The tax for the order.
orderAmounts.total
float
The total for the order.
charges
array
A list of charges related to a shipment.
charges[].code
string
The code for the charge.
charges[].description
string
The description of the charge.
charges[].amount
float
The charge amount.
soldTo
object
The object that describes the sold-to information for the order.
soldTo.number
string
The sold-to account number for the order.
soldTo.name
string
The name of the sold-to recipient for the order.
soldTo.links
object
The object that describes the URL for the sold-to account.
soldTo.links.href
string
The reference to the specific sold-to account for the order.
billTo
object
The object that describes the bill-to information for the order.
billTo.number
string
The bill-to document number for the order.
billTo.name
string
The name of the bill-to recipient for the order.
billTo.links
object
The object that describes the URL for the bill to information.
billTo.links.href
string
The reference to the specific bill-to account for the order.
shipTo
object
The object that describes the ship-to information for the order.
shipTo.number
string
The unique ABC ship-to account number identifying the ship-to location receiving the item.
shipTo.name
string
The name of the ship-to recipient for the order.
shipTo.links
object
The object that describes the URL for the ship-to information.
shipTo.links.href
string
The reference to the specific ship-to account for the order.
branch
object
The object that describes the branch information for an order.
branch.number
string
The unique ABC branch number identifying the branch location sourcing the item.
branch.name
string
The name of the branch.
branch.storefront
string
The name of the storefront at the branch specified.
branch.links
object
The object describing the URL for the branch related to the order.
branch.links.href
string
The reference to the branch related to the order.
lines
array
A list of line items for the order.
lines[].id
integer
The unique ID of the line item. This may be an order line item or any other number key to your application.
lines[].itemNumber
string
The unique ABC item number identifying the product.
lines[].links
object
The object describing the URL for the item.
lines[].links.href
string
The reference link to the item.
lines[].dimensions
object
The object describing the item’s dimensions.
lines[].dimensions.length
object
The object that describes the length of the item.
lines[].dimensions.length.value
float
The value of the length dimension.
lines[].dimensions.length.uomCode
string
The unit of measure code of the item’s length (e.g., “ft”: feet, “in”: inches).
lines[].dimensions.length.uom
string
The description of the unit of measure.
lines[].orderedQty
object
The object that describes the quantity of the item.
lines[].orderedQty.value
integer
The quantity of the item ordered.
lines[].orderedQty.uomCode
string
The unit of measure code of the quantity (e.g., “PC”: pieces).
lines[].orderedQty.uom
string
The description of the unit of measure.
lines[].unitPrice
object
The object that describes the item’s price.
lines[].unitPrice.value
float
The value of the item price.
lines[].unitPrice.uomCode
string
The pricing unit of measure code (e.g. “SQ”).
lines[].unitPrice.uom
string
The pricing unit of measure (e.g. “Squares”).
lines[].amount
float
The total price of the line item.
lines[].comments
array
The object describing comments relating to a line item.
lines[].comments.code
string
The code of the comment.
lines[].comments.description
string
The description of the comment.
shipments
array
A list of shipment information for each shipment of an order.
shipments[].shipmentNumber
string
The shipment number.
shipments[].status
string
The status code of the shipment.
shipments[].total
float
Total shipment amount.
shipments[].dates
object
The object describing the date information of a shipment delivery.
shipments[].dates.deliveryRequestedOn
string
The date for which the delivery is requested.
shipments[].dates.deliveredOn
string
The date the order was delivered.
shipments[].dates.invoicedOn
string
The date the shipment was invoiced.
shipments[].address
object
The object describing the shipment’s delivery address information.
shipments[].address.line1
string
The first line of the delivery address, usually including the street number and name.
shipments[].address.line2
string
The second line of the delivery address, which may include additional information like building numbers.
shipments[].address.line3
string
The third line of the delivery address, which may include more specific location information or additional directions.
shipments[].address.city
string
The city for the delivery address.
shipments[].address.state
string
The state for the delivery address.
shipments[].address.postal
string
The zip code for the delivery address.
shipments[].address.country
string
The country for the delivery address (e.g., “USA”).
shipments[].comments
array
A list of comments related to the shipment.
shipments[].comments[].code
string
The comment code. The default value is “0”.
shipments[].comments[].description
string
The text of the shipment comment.
shipments[].amounts
object
The object describing the price amounts for the shipment.
shipments[].amounts.subTotal
float
The subtotal for the shipment.
shipments[].amounts.tax
float
The tax amount for the shipment.
shipments[].amounts.total
float
The total amount for the shipment.
shipments[].charges
array
The array of charges related to the shipment.
shipments[].charges[].code
string
The code for the charge.
shipments[].charges[].descrption
string
The description for the charge.
shipments[].charges[].amount
float
The amount for the charge.
shipments[].deliveryHistory
array
The array of delivery updates in the shipping history.
shipments[].deliveryHistory[].name
string
The name of the delivery status update.
shipments[].deliveryHistory[].code
string
The code for the delivery status update.
shipments[].deliveryHistory[].ladingException
string
The lading exception for the delivery status update, if applicable.
shipments[].deliveryHistory[].notes
string
The notes for the delivery status update, if applicable.
shipments[].deliveryHistory[].localTime
string
The datetime of the delivery status update in local time.
shipments[].deliveryHistory[].utcTime
string
The datetime of the delivery status update in UTC time.
shipments[].lines
array
A list of lines for the shipped item(s).
shipments[].lines[].id
string
The ID of the line for the shipped item.
shipments[].lines[].itemNumber
string
The ABC Supply item number.
shipments[].lines[].links
object
The object describing the URL for the item.
shipments[].lines[].links.href
string
The reference link to the item.
shipments[]lines[].dimensions
object
The object describing the item’s dimensions. Required depending on the item.
shipments[].lines[].dimensions.length
object
The object that describes the length of the item.
shipments[].lines[].dimensions.length.value
float
The value of the length dimension.
shipments[].lines[].dimensions.length.uomCode
string
The unit of measurement code of the item’s length (e.g., “ft”: feet, “in”: inches).
shipments[].lines[].dimensions.length.uom
string
The description of the unit of measurement.
shipments[].lines[].orderedQty
object
The object that describes the quantity of the item.
shipments[].lines[].orderedQty.value
integer
The quantity of the item ordered.
shipments[].lines[].orderedQty.uomCode
string
The unit of measurement code of the quantity (e.g., “PC”: pieces, “SQ”: squares).
shipments[].lines[].orderedQty.uom
string
The description of the unit of measurement.
shipments[].lines[].unitPrice
object
The object that describes the item’s price.
shipments[].lines[].unitPrice.value
float
The value of the item price.
shipments[].lines[].unitPrice.uomCode
string
The unit of measure code of the item price.
shipments[].lines[].unitPrice.uom
string
The name of the price unit of measurement.
shipments[].lines[].amount
float
The line item price amount.
shipments[].lines[].comments
array
The object describing comments relating for the line item.
shipments[].lines[].comments[].code
string
The code of the line item comment.
shipments[].lines[].comments[].description
string
The description of the line item comment.
HTTP Status Codes
Name
Type
Description
503
string
Get order service is not available.
500
string
Server error.
Additional Examples
Example Response
Response for an order failed to submit due to invalid JSON
{
"message": "Bad Request - Invalid JSON"
}