Get custom order status

Get information about specific order status

Access scopes

Requires the following access scope: read_store_profile

Response

JSON with information about specified order status

FieldTypeDescription
statusIdstringSupported 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
orderStatusTypestringSupported values: PAYMENT_STATUS,FULFILLMENT_STATUS
defaultStatusbooleantrue for default statuses, falsefor custom statuses
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
lastNameChangeDatestringDate and time of the last custom status name change in a UTC, e.g. "2023-01-01 12:00:00 +0000"

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
Click Try It! to start a request and see the response here!