get https://app.ecwid.com/api/v3//profile/order_statuses
Get information about all order statuses in the store
Access scope required: read_store_profile
Headers
| Name | Type | Description |
|---|---|---|
| Authorization | string | oAuth token with mandatory Bearer before it. Example: Bearer e***s0, where e***s0 should be replaced with your oAuth token. |
Response
JSON with itemsarray containing information about order statuses
| Field | Type | Description |
|---|---|---|
| statusId | string | Supported values: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 |
| orderStatusType | string | Supported values: PAYMENT_STATUS,FULFILLMENT_STATUS |
| defaultStatus | boolean | true for default statuses, falsefor custom statuses |
| enabled | boolean | trueif status is enabled and can be used in the store, falseotherwise |
| sendNotificationWhenStatusIsAssigned | boolean | When order status is changed, store will send an "Order status updated" email to customer (if this notification is enabled) if true, falseto disable notifications for the custom status |
| name | string | Name of a custom order status showed in the Control Panel and in emails |
| nameTranslations | <Translations> | Name translations for custom order statuses in languages currently enabled in store |
| lastNameChangeDate | string | Date and time of the last custom status name change in a UTC, e.g. "2023-01-01 12:00:00 +0000" |
Translations
| Field | Type | Description |
|---|---|---|
| <ISO_LANG_CODE> | string | Translations for each available language. If no other translations are provided, the default language translations is returned. See available languages in store language settings |