Developers

Delivery

Markdown

List delivery options

Your app's delivery options on this store, and whether the merchant turned each one on.

GET/stores/{storeId}/v1/delivery-options

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

HTTPCodeMeaning
403SCOPE_REQUIREDThe token does not carry the required scope.
503APPS_SCOPE_RUNTIME_NOT_READYThe resource is not enabled on this merchant's store yet.

Shared codes are listed in Errors.

    ↑↓ moveEnter openEsc close