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.

The Get Order Templates API returns the details of a template . This template is an order template that has been created on the myABCSupply platform. This template will include details about the template, such as name and description, as well as the delivery address, items, and the home branch that the template can be ordered from.

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 History (with Start date and End Date)

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": "97211",
  "name": "Order template",
  "description": "Order template for roof jobs",
  "createdDate": "2024-07-18T19:08:45.273",
  "branch": {
    "number": 52,
    "address": "333 1st Ave, Longmont, CO 80501-5958"
  },
  "deliveryAddress": {
    "line1": "764 Greenwood Springs Dr.",
    "line2": "Bldg 2",
    "line3": "Section 2 Pre Rock",
    "city": "Greenwood",
    "state": "IN",
    "postal": "46143",
    "country": "USA"
  },
  "lines": [
    {
      "itemNumber": "02ATSSH4HB",
      "itemDescription": "Atlas StormMaster Shake Core4 Highland Brown 3 Bundles Per Square",
      "uom": {
        "description": "BD  -  Bundle"
      },
      "orderedQty": {
        "value": 10
      },
      "unitPrice": {
        "value": 10
      },
      "amount": 100
    }
  ]
}

Expand

Name

Type

Description

templateId

string

The unique identifier for the template, used to retrieve the template details.

name

string

The user created name of the template.

description

string

The user created description for the template, describing what the template should be used for.

createdDate

string

The date the template was created (e.g., "2019-12-20").

branch.number

integer

The unique identifier of the branch.

branch.address

string

The full address of the branch.

deliveryAddress.line1

string

This is the first line of the address, usually including the street number and name.

deliveryAddress.line2

string

This is the second line of the address, which may include additional information like building numbers.

deliveryAddress.line3

string

This is the third line of the address, often used for more specific location information or additional directions.

deliveryAddress.city

string

The city of the address.

deliveryAddress.state

string

The state of the address.

deliveryAddress.postal

string

The postal code of the address.

deliveryAddress.country

string

The country code of the address.

lines[].itemNumber

string

The unique identifier for the product.

lines[].itemDescription

string

The description of the product.

lines[].uom.description

string

The full text description of the unit of measure.

lines[].orderedQty.value

decimal

The quantity ordered of the product.

lines[].unitPrice.value

decimal

The cost of each unit of the product.

amount

decimal

The total amount of the order with all products.

HTTP Status Codes

Name

Type

Description

400

string

Bad Request – Invalid JSON.

401

string

The account/shipTo provided does not have access to the requested data. Please try again with a different account.

404

string

Object not found.

503

string

Get order service is not available.

500

string

Server error.

Order API

order API