Search order statuses

GET https://app.ecwid.com/api/v3/{storeId}/profile/order_statuses

Request and response example

Request:

GET /api/v3/1003/profile/order_statuses HTTP/1.1
Authorization: Bearer secret_token
Host: app.ecwid.com

Response:

{
    "items": [
        {
            "statusId": "AWAITING_PAYMENT",
            "orderStatusType": "PAYMENT_STATUS",
            "defaultStatus": true,
            "enabled": true,
            "sendNotificationWhenStatusIsAssigned": true
        },
        {
            "statusId": "PAID",
            "orderStatusType": "PAYMENT_STATUS",
            "defaultStatus": true,
            "enabled": true,
            "sendNotificationWhenStatusIsAssigned": true
        },
        {
            "statusId": "CANCELLED",
            "orderStatusType": "PAYMENT_STATUS",
            "defaultStatus": true,
            "enabled": true,
            "sendNotificationWhenStatusIsAssigned": true
        },
        {
            "statusId": "REFUNDED",
            "orderStatusType": "PAYMENT_STATUS",
            "defaultStatus": true,
            "enabled": true,
            "sendNotificationWhenStatusIsAssigned": true
        },
        {
            "statusId": "PARTIALLY_REFUNDED",
            "orderStatusType": "PAYMENT_STATUS",
            "defaultStatus": true,
            "enabled": true,
            "sendNotificationWhenStatusIsAssigned": true
        },
        {
            "statusId": "INCOMPLETE",
            "orderStatusType": "PAYMENT_STATUS",
            "defaultStatus": true,
            "enabled": true,
            "sendNotificationWhenStatusIsAssigned": true
        },
        {
            "statusId": "CUSTOM_PAYMENT_STATUS_1",
            "orderStatusType": "PAYMENT_STATUS",
            "enabled": false,
            "sendNotificationWhenStatusIsAssigned": true
        },
        {
            "statusId": "CUSTOM_PAYMENT_STATUS_2",
            "orderStatusType": "PAYMENT_STATUS",
            "enabled": false,
            "sendNotificationWhenStatusIsAssigned": true
        },
        {
            "statusId": "CUSTOM_PAYMENT_STATUS_3",
            "orderStatusType": "PAYMENT_STATUS",
            "enabled": false,
            "sendNotificationWhenStatusIsAssigned": true
        },
        {
            "statusId": "AWAITING_PROCESSING",
            "orderStatusType": "FULFILLMENT_STATUS",
            "defaultStatus": true,
            "enabled": true,
            "sendNotificationWhenStatusIsAssigned": true
        },
        {
            "statusId": "PROCESSING",
            "orderStatusType": "FULFILLMENT_STATUS",
            "defaultStatus": true,
            "enabled": true,
            "sendNotificationWhenStatusIsAssigned": true
        },
        {
            "statusId": "SHIPPED",
            "orderStatusType": "FULFILLMENT_STATUS",
            "defaultStatus": true,
            "enabled": true,
            "sendNotificationWhenStatusIsAssigned": true
        },
        {
            "statusId": "DELIVERED",
            "orderStatusType": "FULFILLMENT_STATUS",
            "defaultStatus": true,
            "enabled": true,
            "sendNotificationWhenStatusIsAssigned": true
        },
        {
            "statusId": "WILL_NOT_DELIVER",
            "orderStatusType": "FULFILLMENT_STATUS",
            "defaultStatus": true,
            "enabled": true,
            "sendNotificationWhenStatusIsAssigned": true
        },
        {
            "statusId": "RETURNED",
            "orderStatusType": "FULFILLMENT_STATUS",
            "defaultStatus": true,
            "enabled": true,
            "sendNotificationWhenStatusIsAssigned": true
        },
        {
            "statusId": "READY_FOR_PICKUP",
            "orderStatusType": "FULFILLMENT_STATUS",
            "defaultStatus": true,
            "enabled": true,
            "sendNotificationWhenStatusIsAssigned": true
        },
        {
            "statusId": "OUT_FOR_DELIVERY",
            "orderStatusType": "FULFILLMENT_STATUS",
            "defaultStatus": true,
            "enabled": true,
            "sendNotificationWhenStatusIsAssigned": true
        },
        {
            "statusId": "CUSTOM_FULFILLMENT_STATUS_1",
            "orderStatusType": "FULFILLMENT_STATUS",
            "enabled": false,
            "sendNotificationWhenStatusIsAssigned": true
        },
        {
            "statusId": "CUSTOM_FULFILLMENT_STATUS_2",
            "orderStatusType": "FULFILLMENT_STATUS",
            "enabled": false,
            "sendNotificationWhenStatusIsAssigned": true
        },
        {
            "statusId": "CUSTOM_FULFILLMENT_STATUS_3",
            "orderStatusType": "FULFILLMENT_STATUS",
            "enabled": false,
            "sendNotificationWhenStatusIsAssigned": true
        }
    ]
}

Required access scopes

Your app must have the following access scopes to make this request: read_store_profile

Path params

All path params are required.

Param	Type	Description
storeId	number	Ecwid store ID.

Headers

The Authorization header is required.

Header	Format	Description
Authorization	Bearer secret_ab***cd	Access token of the application.

Response JSON

A JSON object with the following fields:

Field	Type	Description
items	array of objects items	Details about all order statuses.

items

Field	Type	Description
statusId	string	One of: AWAITING_PAYMENT PAID CANCELLED REFUNDED PARTIALLY_REFUNDED INCOMPLETE CUSTOM_PAYMENT_STATUS_1 CUSTOM_PAYMENT_STATUS_2 CUSTOM_PAYMENT_STATUS_3 AWAITING_PROCESSING PROCESSING SHIPPED DELIVERED WILL_NOT_DELIVER RETURNED READY_FOR_PICKUP OUT_FOR_DELIVERY CUSTOM_FULFILLMENT_STATUS_1 CUSTOM_FULFILLMENT_STATUS_2 CUSTOM_FULFILLMENT_STATUS_3 Read more about order statuses in Help Center.
orderStatusType	string	Defines if it's a payment or shipping status. One of: PAYMENT_STATUS FULFILLMENT_STATUS
defaultStatus	boolean	Defines if it's a built-in status (true) or a custom one (false). Custom order statuses: CUSTOM_PAYMENT_STATUS_1 CUSTOM_PAYMENT_STATUS_2 CUSTOM_PAYMENT_STATUS_3 CUSTOM_FULFILLMENT_STATUS_1 CUSTOM_FULFILLMENT_STATUS_2 CUSTOM_FULFILLMENT_STATUS_3
enabled	boolean	Defines if the status is enabled and can be used in the store.
sendNotificationWhenStatusIsAssigned	boolean	Defines if the "Order status updated" email should be automatically sent to customers.
name	string	Name of the order status visible in Ecwid admin and emails. Available only for custom order statuses
nameTranslated	object translations	Available translations for the order status name. Available only for custom order statuses
lastNameChangeDate	string	Datetime of the latest name change for custom order statuses in UTC +0. For example, 2023-01-01 12:00:00 +0000 Available only for custom order statuses

translations

Object with text field translations in the "lang": "text" format, where the "lang" is an ISO 639-1 language code. For example:

{
    "en": "Sample text",
    "nl": "Voorbeeldtekst"
}

Translations are available for all active store languages. Only the default language translations are returned if no other translations are provided for the field. Find active store languages with GET /profile request > languages > enabledLanguages.