Skip to navigation
StorefrontRequests

Create Request

View as Markdown

Sends an order request to the merchant: products sold through order requests, products with an open price, or a custom request with no variant_id. Nothing is charged. The merchant is emailed, the shopper gets a confirmation with the reference, and the merchant replies with a price. When the shopper is signed in, send shopper-token to link the request to their account and to save measurements answered with save_as.

Keys: public key or secret key.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

identitystring
The identity for the active workspace.

Headers

channelstringRequired
shopper-tokenstringOptional
Send it when the shopper is signed in.
client-ipstringOptional
The shopper's IP address. Read only when the request is signed with a secret key, so a server calling on behalf of many shoppers does not share one rate limit. Ignored for public keys.

Request

This endpoint expects an object.
namestringRequired<=100 characters
emailstringRequiredformat: "email"<=255 characters
Where the confirmation and the merchant's reply go.
phonestringRequired<=30 characters
needed_bydateRequired
Date the shopper needs the order by, from today up to two years ahead and no earlier than the longest lead time of the items.
itemslist of objectsRequired
fulfilmentenumOptional

Defaults to PICKUP. DELIVERY needs address with at least line1 and city.

Allowed values:
addressobjectOptional
notesstringOptional<=2000 characters

Plain text; markup is removed.

photoslist of stringsOptional

Picture ids from Upload Request Picture that belong to the whole request.

Response

Successfully sent request
statusboolean

Always true on success.

messagestring

Human-readable outcome.

dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error