Store
Get the store profile
The store name, contact details, VAT number, commercial registration, national address and pickup address, as the merchant filled them.
GET/stores/{storeId}/v1/store
A field the merchant has not filled is null. A delivery app reads pickup_address to know where to collect shipments. An accounting app reads legal_name, vat_number and commercial_registration for its documents. See Accounting and invoices.
Response
- dataobjectrequired
- idstring (uuid)required
- namestring | null
- legal_namestring | null
- The legal name, as on the commercial registration.
- domainstring | null
- urlstring | null (uri)
- currencystringrequired
SAR- localestringrequired
ar- countrystringrequired
SA- logo_urlstring | null
- emailstring | null
- phonestring | null
- vat_numberstring | null
- The VAT number, or null when the merchant has not filled it.
- commercial_registrationstring | null
- national_addressstring | null
- pickup_addressobject | null
- The pickup address the merchant filled, or null.
- namestring | null
- contact_namestring | null
- phonestring | null
- emailstring | null
- countrystring | null
- citystring | null
- districtstring | null
- streetstring | null
- postal_codestring | null
- executionobject
- Who executed the request: the app, version, installation and store. Field names here are camelCase.
- appIdstring (uuid)
- versionIdstring (uuid)
- installationIdstring (uuid)
- storeIdstring (uuid)
- requestIdstring (uuid)
- generationinteger
- routeEpochinteger
- appAuthEpochinteger
- grantRevisioninteger
- metaobjectrequired
- request_idstring (uuid)
- The request ID; include it in any support request.
Errors
| HTTP | Code | Meaning |
|---|---|---|
| 403 | SCOPE_REQUIRED | The token does not carry the required scope. |
Shared codes are listed in Errors.