Skip to content

Create order

Use the Order create API to start the production and shipping process against your Promise UID returned from the Quote API.

POST https://api.gelato.com/v2/order/create

Request example

$ curl -X POST \
   https://api.gelato.com/v2/order/create \
   -H 'Content-Type: application/json' \
   -H 'X-API-KEY: {{apiKey}}' \
   -d '{"promiseUid": "{{promise_uid}}"}'

Response example

{
  "message": "Promise Uid is accepted for processing"
}

Query Parameters

Parameter Type Description
promiseUid (required) string A promiseUid returned from the Quote API response.
Pattern: ^d_[a-zA-Z0-9]{24}$
customerReferenceId (optional) string Reference to your internal customer id. (Populate if you want to override value sent earlier in order quote request)
orderReferenceId (optional) string Reference to your internal order id. (Populate if you want to override value sent earlier in order quote request)

Response Parameters

Parameter Type Description
message (required) string Human-readable response to the order create status.

Response Messages

Error response example:

{
  "message": "Invalid request body."
}
HTTP Status Code Message
200 Order submitted for processing.
400 Invalid request body.