Update custom order status

PUT https://app.ecwid.com/api/v3/{storeId}/profile/order_status/{statusId}

Request and response example

Request:

PUT /api/v3/1003/profile/order_status/CUSTOM_PAYMENT_STATUS_1 HTTP/1.1
Authorization: Bearer secret_token
Host: app.ecwid.com
Content-Type: application/json
Cache-Control: no-cache

{
    "name": "Money on hold",
    "enabled": true,
    "sendNotificationWhenStatusIsAssigned": true
}

Response:

{
    "updateCount": 1
}

Required access scopes

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

Path params

All path params are required.

Param	Type	Description
storeId	number	Ecwid store ID.
statusId	string	Status ID in the same format as in the statusId field. Case sensitive. Supports only custom 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

Headers

The Authorization header is required.

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

Request JSON

A JSON object with the following fields:

Field	Type	Description
enabled	boolean	Set true to enable custom status in the store.
sendNotificationWhenStatusIsAssigned	boolean	Set true to enable automatic "Order status updated" email notifications for customers.
name	string	Name of the custom order status visible in Ecwid admin and emails.
nameTranslations	object translations	Available translations for the custom order status name.

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.

Response JSON

A JSON object with the following fields:

Field	Type	Description
updateCount	number	The number of updated items that defines if the request was successful. One of: 1 if the item was updated, 0 if the item was not updated.