POST
/
oms-notifications
/
acknowledge

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-fabric-tenant-id
string
required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-channel-id
string
required

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

x-fabric-request-id
string

Unique request ID

Body

application/json

Acknowledgment request details

acknowledgedAt
string
required

Notification event acknowledgement time (UTC format)

documentId
string
required

Unique ID based on documentType. When documentType is ORDER, this is the order ID.

documentType
enum<string>
required

Module name

Available options:
ALLOCATION,
ORDER,
LOCATION,
SHIPMENT,
INVENTORY,
INVOICE,
TRANSFER,
LOCATION_OUTAGE,
TRANSFER_SHIPMENT,
LOCATION_CAPACITY_OVERRIDE
notificationType
enum<string>
required

Notification type

Available options:
SINGLE_ITEM_ORDER_CONFIRMATION_EMAIL,
MULTI_ITEM_ORDER_CONFIRMATION_EMAIL,
BOPIS_ORDER_CONFIRMATION_EMAIL,
SHIPPING_CONFIRMATION_EMAIL,
BOPIS_ORDER_READY_FOR_PICKUP,
BOPIS_ORDER_COMPLETED,
BOPIS_REMINDER_EMAIL,
BACKORDER_NOTIFICATION_EMAIL,
BACKORDER_30_DAYS_CONSENT_TO_DELAY_EMAIL,
BACKORDER_53_DAYS_CONSENT_TO_DELAY_EMAIL,
BACKORDER_CANCEL_EMAIL,
BACKORDER_AUTH_DECLINE_EMAIL,
ORDER_CANCELLATION_EMAIL_WEBCSC_ORDER_ITEM_CANCEL,
ORDER_CANCELLATION_EMAIL_WEBCSC_ORDER_CANCEL,
ORDER_CANCELLATION_EMAIL_LOCATE_ORDER_ITEM_CANCEL,
RETURN_NOTIFICATION_EMAIL,
REFUND_NOTIFICATION_EMAIL,
APPEASEMENT_NOTIFICATION_EMAIL,
EXCHANGE_NOTIFICATION_EMAIL,
SHIPMENT_CREATED,
ORDER_CREATED,
INVOICE_POSTED,
HIGH_ALERT_NOTIFICATION_EMAIL,
MEDIUM_ALERT_NOTIFICATION_EMAIL,
LOW_ALERT_NOTIFICATION_EMAIL,
PAYMENT_AUTH_DECLINED_EMAIL

Response

200 - application/json

Response message

message
string

Response message