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.
The Update Webhook endpoint updates the configuration of a webhook that has been previously registered. The request must include the configuration parameters to be updated, such as name, data format, event type, URL, etc. The endpoint response includes the webhook id, name, status, and a link to the webhook registration request.
Notification API
Update Webhook
PATCH /webhooks/{webhookId}
Update an existing webhook configuration
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 ID of the partner.
type
enum
The type of registration (e.g., “order:). Order is the only webhook supported at this time.
events
array
The list of events with which to register (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 webhook (e.g., “json”). JSON is the only supported format at this time.
Example Request
URI Parameters
The unique identifier {webhookId} representing a specific webhook.
PATCH /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
{
"id": "11c1fec0-8252-4464-a6d8-9732cee59da7",
"name": "Order Acknowledgement",
"status": "REGISTERED",
"links": {
"self": "https://partners.abcsupply.com/api/notification/v2/webhooks/11c1fec0-8252-4464-a6d8-9732cee59da7"
}
}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.
link
object
The object containing the URL information for the registration request.
link.self
string
The reference URL to the registration request.
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.