Update order status

Update a specific order status

📘

Access scopes required: read_store_profile and update_store_profile

Headers

NameTypeDescription
AuthorizationstringoAuth token with mandatory Bearer before it. Example: Bearer e***s0, where e***s0 should be replaced with your oAuth token.

Request

FieldTypeDescription
enabledbooleantrueif status is enabled and can be used in the store, falseotherwise
sendNotificationWhenStatusIsAssignedbooleanWhen 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
namestringName 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

Translations

FieldTypeDescription
<ISO_LANG_CODE>stringTranslations for each available language. If no other translations are provided, the default language translations is returned. See available languages in store language settings
Language
Authorization
Query