Store
Update the store's details
Like Settings → General: the store's name, contact, address, the storefront's language, the timezone and the order-number prefix. Send only what changes. The prefix applies to orders created from now on.
Body
- namestring
1–80 characters
- languagestring
The storefront language. ar-ltr: Arabic text on a left-to-right page.
One of
ar,ar-ltr,fr,en - timezonestring
An IANA timezone such as Africa/Algiers.
up to 64 characters
- order_prefixstring
Stored in capitals.
- contactobject
2 child fields
- emailstring or null
up to 254 characters
- phonestring or null
up to 32 characters
- addressobject
3 child fields
- regionstring or null
up to 10 characters
- citystring or null
up to 120 characters
- streetstring or null
up to 240 characters
Returns
200 OK · The store. Store
- idstringRequired
starts with sto_
- objectstringRequired
always "store"
- namestringRequired
- slugstring or null
The store's address on ordexs.com.
nullin test mode. - urlstring or null
The public storefront.
nullin test mode.uri
- countrystringRequired
ISO 3166-1 alpha-2 country the store sells in.
- currencyCurrencyRequired
2 child fields
- codestringRequired
ISO 4217 currency code.
- exponentintegerRequired
Number of decimals every amount in this currency has (DZD 2, TND 3).
- planstring
The store's Ordexs plan. Decides rate limits.
One of
starter,growth,scale - languagestring
The storefront language.
One of
ar,ar-ltr,fr,en - timezonestring
- order_prefixstring
The start of order numbers, as in ORD-00042.
- contactobject
2 child fields
- emailstring or null
- phonestring or null
- addressobject
3 child fields
- regionstring or null
- citystring or null
- streetstring or null
- livemodebooleanRequired
falsewhen the request was made with a test key. - created_atstringRequired
ISO 8601 date-time, UTC
- updated_atstringRequired
ISO 8601 date-time, UTC
Errors
Every error has the same shape. This endpoint can answer with:
