Get Order Template By ID

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.

Get Order Template by ID returns the data in an order template created within the user’s Bill-To account in the myABCSupply portal. The response includes the template name, description, delivery address, items and their quantities, and the branch selected for the template. The template ID can be found using the Get Order Templates endpoint.

order API

GET /orders/templates/{templateId}

Get order template details by ID

Sandbox

Resource:

GET

https://partners-sb.abcsupply.com/api/order/v2/orders/templates/{templateId}

Production

Resource:

GET

https://partners.abcsupply.com/api/order/v2/orders/templates/{templateId}

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 Template by Template ID

Parameter

Value

templateId

The unique identifier of the template being returned.

Example Request

GET /api/order/v2/orders/templates/97211 HTTP/1.1
Host: partners.abcsupply.com
Authorization: Bearer <TOKEN>

Expand

Response

Example Response

{
    "templateId": 73875,
    "name": "User Test Template",
    "description": "Order template for future ordering - test",
    "createdDate": "2024-12-09T21:24:35.107",
    "branch": {
        "number": 118,
        "address": "5602 S 300 W, Murray, UT 84107-5901"
    },
    "deliveryAddress": {
    	"line1": "764 Greenwood Springs Dr.",
    	"line2": "Bldg 2",
    	"line3": "Section 2 Pre Rock",
    	"city": "Greenwood",
    	"state": "IN",
    	"postal": "46143",
    	"country": "USA"
    },
    "lines": [
        {
            "itemNumber": "4424707526",
            "itemDescription": "Clean Sweep 5\" Wicker 4' Aluminum",
            "uom": {
                "name": "Piece",
                "code": "PC"
            },
            "orderedQty": {
                "value": 1
            },
            "unitPrice": {
                "value": 11.99
            },
            "amount": 11.99
        },
        {
            "itemNumber": "1564001003",
            "itemDescription": "Gutterfoam Foam Insert 5\" #GF-K5",
            "uom": {
                "name": "Piece",
                "code": "PC"
            },
            "orderedQty": {
                "value": 3
            },
            "unitPrice": {
                "value": 11.99
            },
            "amount": 35.97
        }
    ]
}

Expand

Name

Type

Description

templateId

string

The unique identifier for the order template.

name

string

The user-created name of the order template.

description

string

The user-created description for the order template.

createdDate

string

The date-time of template creation.

branch

object

The object that describes the selected ABC Supply branch for the order template.

branch.number

integer

The ABC Supply branch number.

branch.address

string

The ABC Supply branch address.

deliveryAddress

object

The object that contains delivery address information for the order template.

deliveryAddress.line1

string

The first line of the delivery address.

deliveryAddress.line2

string

The second line of the delivery address.

deliveryAddress.line3

string

The third line of the delivery address.

deliveryAddress.city

string

The city for the delivery address.

deliveryAddress.state

string

The state for the delivery address.

deliveryAddress.postal

string

The postal code for the delivery address.

deliveryAddress.country

string

The country for the delivery address.

lines

array

The list of items, quantities, and prices in the order template.

lines[].itemNumber

string

The ABC Supply item number.

lines[].itemDescription

string

The description of the item.

lines[].uom

object

The uom selected for the item.

lines[].uom.name

string

The name of the uom selected for the item.

lines[].uom.code

string

The code for the uom selected for the item.

lines[].orderedQty.value

integer

The quantity value for the item.

lines[].unitPrice

object

The object describing the item unit price in the order template.

lines[].unitPrice.value

float

The unit price value for the item.

amount

float

The total pre-tax amount for the item based on quantity and price.

HTTP Status Codes

Code

Status

Description

200

Request and response succeeded.

401

Unauthorized

The user’s account does not have access to the order template with the provided ID.

404

Not Found

The order template with the provided ID has not been created.

500

Internal Server Error

The service is unavailable.