Shipment notification configuration API (v0)

Download OpenAPI specification:Download

Use these APIs to manage notification options for your shipment related events.

Note: NewStore sends a confirmation to the customer when all the items in a fulfillment request have been processed for shipment. For example, a confirmation is sent to the customer only when all items in the fulfillment request have been dispatched for delivery, or when all items have been delivered.

Possible notifications are:

shipment_dispatched: Sent when a shipment left the fulfillment location and is on its way to the customer.

shipment_delayed: Sent when a shipment is delayed because the fulfillment takes longer than expected.

shipment_cancelled: Sent when a shipment is canceled.

shipment_delivered: Sent when a shipment is delivered to the customer.

shipping_option.estimate_changed: Sent when the estimated time of delivery has changed.

package.status_updated: Sent when the status of a delivery has changed.

in_store.ready_for_pick_up: Sent when an in-store pickup order is ready to be picked up.

Get shipment notification options

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

See the parent resource for possible options.

Authorizations:

newStoreAccessToken

Responses

Response samples

200

Content type

application/json

{"value": {"options": {"shipment_dispatched": ["email"
],
"shipment_delivered": ["email"
]
},
"timezone": "UTC"
},
"updated_at": "2021-07-13T20:18:25Z"
}

Set shipment notification options

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

Important: Ensure that you provide all the options in the request, as this method does not allow you to make partial updates to shipment notifications.

See the parent resource for possible options.

Authorizations:

newStoreAccessToken

Request Body schema: application/json

required

object

required	object A map of possible notifications that can be sent to the customer.
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.
timezone	string Defines the timezone times are rendered in for the 'shipping_option.estimate_changed' notification. The string should conform to the IANA Time Zone database, like: 'America/New_York'.

Responses

Request samples

Payload

Content type

application/json

{"value": {"options": {"shipment_dispatched": ["email"
],
"shipment_delivered": ["email"
]
},
"timezone": "UTC"
}
}

Response samples

400
500

Content type

application/json

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