Delivery
Replace delivery options
Replaces your app's whole list, up to 10 options. Send an empty list to remove them all.
POST/stores/{storeId}/v1/delivery-options
Customers see an option only after the merchant turns it on. A changed price or company name turns it off again until the merchant reviews it. See Delivery companies.
Request body
- optionsarray<object>required
- Replaces your app's whole list.
- keystringrequired
- A stable key for the option inside your app.
- company_namestringrequired
- The company name the customer sees.
- labelstringrequired
- The name the customer sees.
- etastring | null
- The delivery time as the customer reads it.
- pricestringrequired
- The price in SAR, from 0 to 1000.
- citiesarray<string>
- The cities covered, in Arabic as customers write them; an empty list means every city in Saudi Arabia.
Response
- dataarray<object>required
- keystring
- A stable key for the option inside your app.
- company_namestring
- The company name the customer sees.
- labelstring
- The name the customer sees.
- etastring | null
- The delivery time as the customer reads it.
- pricestring
- Price in SAR.
- citiesarray<string>
- The cities covered, in Arabic as customers write them; an empty list means every city in Saudi Arabia.
- enabledboolean
- false until the merchant turns it on, and back to false when the price or company name changes.
- updated_atstring (date-time)
- 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 |
|---|---|---|
| 422 | INVALID_DELIVERY_OPTIONS | Not a list, more than 10 options, a repeated or invalid key, or more than 50 cities. |
| 422 | INVALID_PRICE | The price is not a string from 0 to 1000 with up to two decimals. |
| 403 | SCOPE_REQUIRED | The token does not carry the required scope. |
| 503 | APPS_SCOPE_RUNTIME_NOT_READY | The resource is not enabled on this merchant's store yet. |
Shared codes are listed in Errors.