Contents

Register a device for update notifications

Registers a device to receive update notifications for an order.

URL

POST https://your-web-service.com/v1/devices/{deviceIdentifier}/registrations/{orderTypeIdentifier}/{orderIdentifier}

Path Parameters

NameTypeDescription
orderIdentifier Requiredstring

The order identifier. This value corresponds to the value of the orderIdentifier key of the Order.

orderTypeIdentifier Requiredstring

The order type identifier of the order. This value corresponds to the value of the orderTypeIdentifier key of the Order.

deviceIdentifier Requiredstring

A unique identifier for the device.

Header Parameters

NameTypeDescription
Authorization Requiredstring

The authentication for an order. The scheme is AppleOrder with the order’s value for the authenticationToken key as parameter. For example, AppleOrder {authenticationToken}.

Response Codes

StatusReasonTypeDescription
200Device Already Registered

The device is already registered for the order.

201Device Registered

The device successfully registered for the order.

401Request Not Authorized

The request isn’t authorized.

Discussion

When the system modifies an order, use the PushToken to send a push notification to the device. In the notification, set the push topic as the order type identifier and leave the payload empty.

HTTP Body

The push token APNS uses to send update notifications to the device.

See Also

Notifications