Order status notifications API (0.1.0)

Download OpenAPI specification:Download

team-order-management: team-order-management@newstore.com

Use these APIs to manage notification options for order related events.

Possible notifications include:

order_pending: Sent after the order is placed.
order_cancelled: Sent when the entire order is canceled.

Get order status notification options

Retrieves the current configuration for the retailer, which contains the notification options specified for order statuses in their business.

See the parent resource for possible options.

Authorizations:

newStoreAccessToken

Responses

Response samples

200

Content type

application/json

{"value": {"push_notification_channel_type": "email",
"options": {"order_cancelled": ["email"
],
"order_pending": ["email"
]
}
},
"updated_at": "2021-07-13T20:18:25Z"
}

Set order status notification options

Sets the configuration for the retailer that contains notification options specified for order statuses in their business.

See the parent resource for possible options.

Authorizations:

newStoreAccessToken

Request Body schema: application/json

required

object

push_notification_channel_type	string Enum: "customer_uuid" "email" Push notification need a channel (type of addressing) for where to send notifications. That can be the internal customer identifier or their email.
required	object A map of enabled notifications and their respective channels.

Responses

Request samples

Payload

Content type

application/json

{"value": {"push_notification_channel_type": "email",
"options": {"order_cancelled": ["email"
],
"order_pending": ["email"
]
}
}
}

Response samples

400
500

Content type

application/problem+json

{"messages": ["string"
],
"request_id": "string"
}