Use it for what the store cannot deliver by itself. content is up to 5,000 characters. An order held for review is delivered by changing its status to completed instead. See Digital products and delivery.
Path parameters
idstringrequired
Headers
Idempotency-Keystringrequired
Request body
contentstringrequired
What the customer sees on the order page and receives by email.
Response
dataobjectrequired
order_idstring
deliveredboolean
true
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
400
IDEMPOTENCY_KEY_REQUIRED
No Idempotency-Key header.
404
RESOURCE_NOT_FOUND
The ID does not exist in this store.
409
ORDER_NOT_PAID
The order is not paid.
409
ORDER_REVIEW_HOLD
The order is held for review. Change its status to completed to deliver its codes.
409
ORDER_TERMINAL
The order is cancelled or refunded.
409
STORE_RULE_REFUSED
A store rule refused the command. Read the resource before you try again.
422
INVALID_INPUT
content is empty or too long.
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.
