Notification API
Subscribe to ABC Supply updates such as order and shipment status. The Notification API allows you to configure webhooks and let ABC Supply push updates to your system in real time.
The ABC API Notification endpoints will be coming soon in a future release.
Webhooks are customizable HTTP callbacks triggered by events and can integrate with your app or third-party APIs. They notify your application of key events, like order or shipment updates. ABC Supply sends HTTP POST requests to your webhook-configured URL every time an order status update occurs.
Use the Register Webhook endpoint to subscribe your URL for real-time updates. Specify the desired webhook type in the request. The endpoint’s response provides registration details, including ID, name, status, and a link to webhook details.
Notification API
Register Webhook
POST /webhooks
Register a new webhook and subscribe to ABC Supply order updates
Sandbox
Production
Authorization
OAuth 2.0 server or user token with the notification.write scope.
Request
Name
Type
Description
partnerName
string
The name of the partner.
partnerId
string
The partner ID.
type
enum
The type of webhook (e.g., “order”). Order is the only webhook supported at this time.
events
array
The list of events to which to subscribe (e.g., “orderAcknowledgement”). Order acknowledgement is the only webhook supported at this time. You will receive a notification through an HTTP POST request when the order is in “processing” status.
url
string
The URL of the webhook being registered. This is the URL that will be invoked when order statuses change.
dataFormat
enum
The format of the request to the webhook (e.g., “json”). JSON is the only supported format at this time.
Example Request
Request for registering a new webhook.
POST /api/notification/v2/webhooks HTTP/1.1
Host: partner.abcsupply.com
Authorization: Bearer <TOKEN>
{
"partnerName":"ABC Partner",
"partnerId":"ACU",
"type": "order",
"events": ["orderAcknowledgement"],
"url" :"https://abcpartner.com/webhook/events/orders",
"dataFormat":"json"
}Response
Example Response
Webhook registration response.
{
"id": "d86fbf63-f7ba-4231-8866-8fb2fe0d27b4",
"name": "Order Acknowledgement",
"status": "REGISTERED",
"links": {
"self": "https://partners.abcsupply.com/api/notification/v2/webhooks/d86fbf63-f7ba-4231-8866-8fb2fe0d27b4"
}
}Name
Type
Description
id
string
The ID of the generated webhook registration.
name
string
The name of the webhook registration response (e.g., “Order Acknowledgement”).
status
string
The status of the registration attempt (e.g., “REGISTERED”).
links
object
The object containing URL information for the webhook.
links.self
string
The URL to the reference of the webhook that was created.
HTTP Status Codes
Name
Type
Description
400
Bad Request
Check the Request to make sure the Request Body and Parameters are passed correctly based on the API documentation.
404
Object Not Found
The request returned empty or no object. Please check the object identifier.