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 a list of template metadata objects. These templates are order templates that were created on the myABCSupply platform.

order API

Get Order Templates

GET /orders/templates

Get order template list

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

accountNumber

The parent account number of the customer account that created the templates.

pageNumber

The number of the page of records to be returned.

itemsPerPage

The maximum number of records to be returned in the response.

Example Request

GET /api/order/v2/orders/templates?accountNumber=27809-1 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

templateId

string

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

accountNumber

string

The unique identifier for the customer account that created the templates.

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").

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.

Additional Examples

N/A