Get Order Templates

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 Templates returns a complete paginated list of order templates created within the user’s Bill-To account in the myABCSupply portal. Each item in the response includes the template ID, Bill-To account number, order template name, description, and template creation datetime. The Get Order Template by ID can be used to retrieve additional order template details.

order API

GET /orders/templates

Get order template list

Sandbox

Resource:

GET

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

Production

Resource:

GET

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

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 Templates Query Parameters

Name

Type

Description

accountNumber

string

The Bill-To account for the requested order templates list.

pageNumber

integer

The page number selection for the order template list results.

itemsPerPage

integer

The number of order templates to return in each response.

Example Request

GET /api/order/v2/orders/templates?pageNumber=1&itemsPerPage=40&accountNumber=86342100 HTTP/1.1
Host: partners.abcsupply.com
Authorization: Bearer <TOKEN>

Expand

Response

Example Response

{
  "templates": [
    {
      "templateId": "97211",
      "accountNumber": "86342100",
      "name": "Order template",
      "description": "Order template for roof jobs",
      "createdDate": "2024-07-18T19:08:45.273"
    }
  ],
  "pagination": {
    "pageNumber": 10,
    "itemsPerPage": 1
  }
}

Expand

Name

Type

Description

pagination

object

The object containing pagination details for the response.

pagination.pageNumber

integer

The page number returned in the response.

pagination.itemsPerPage

integer

The number of items returned per page of the response.

templates

array

The list of templates available for the provided Bill-To account.

templates[].templateId

integer

The unique identifier for the order template.

templates[].accountNumber

string

The Bill-To account associated with the order template.

templates[].name

string

The user-created name of the order template.

templates[].description

string

The user-created description of the order template.

templates[].createdDate

string

The creation datetime of the order template.

HTTP Status Codes

Name

Type

Description

200

Request and response succeeded.

401

Unauthorized

The user’s account does not have access to existing order templates. Verify the account is the correct Bill-To account.

500

Internal Server Error

The service is unavailable.

Order API

order API