Acknowledge Notification by ID

Mark a notification as acknowledged. Acknowledging a notification is to confirm a notification has been received. Acknowledged notification will be removed from the queue to avoid duplicated result for your next query requests.

• URL: {API root URL}/notifications/{id}/ack?customercode={CustomerCode}
• Method: PUT

Request

Please note: For all notification APIs, a notification subscriber key is required in the request header by name Subscriber. Please contact Best Inc. Integration Team to generate this notification subscriber key.

for requests not including subscriber key or incorrect key value was received, a 400 bad request with error message The subscriber is invalid will be received.

URL Parameters

Parameter Name	Required	Data Type	Description
CustomerCode	Y	String	Your unique customer code assigned by Best Inc. system.
Id	Y	String	The internal ID of the notification, the value is provided in Query Notifications or Get Next Notification interface.

Response

Attribute List

Element Name	Data Type	Description
Id	Integer	Internal ID of the notification
EventType	String	The type of the notification. The following are the available notification type: • OrderShipped. Order shipment notification. • OrderRoutingRequest. Order Routing Request notification. • OrderError. Order error notification. • AsnClosed. ASN Closure notification.
EventTime	DateTime	Notification generated time stamp.
CustomerCode	String	Your unique customer code assigned by Best system.
WarehouseCode	String	Indicate the Best Inc. fulfillment center ship your order.
TransactionID	Integer	The internal ID of the order
TransactionNumber	String	The order number
Status	String	Status of the notification
AcknowledgedTime	Integer	The date and time when customer acknowledeged the notification, this field is only available when Status is “Acknowledged”.
Data	Object	The content of the notification, schema varies depends on different event type: • OrderShipped. Order shipment notification. • OrderRoutingRequest. Order Routing Request notification. • OrderError. Order error notification. • AsnClosed. ASN Closure notification.

Response Example

{
    "id": 116137,
    "eventType": "OrderShipped",
    "eventTime": "2019-11-18T21:05:15+00:00",
    "customerCode": "TEST",
    "warehouseCode": "USNJ01",
    "transactionId": 1092748,
    "transactionNumber": "S133184",
    "data": {
        "carrier": "UPS",
        "masterTrackingNumber": "92748909840342443400034074",
        "trackingNumbers": [
            "92748909840342443400034074"
        ]
    },
    "status": "Acknowledged",
    "acknowledgedTime": "2019-11-18T16:10:44-05:00"
}