🚘 Most common scenario or integration point

Clients using a Curbside or Click & Collect model can send vehicle color, plate, recipient name, and other identifiers to improve pickup operations. This data is used by the store staff when handing over the order.

Request Body

{
  "color": "blue",
  "plate": "XYZ123",
  "recipient_name": "John Smith",
  "parking_location": "Zone B",
  "additional_information": "Near the loading dock"
}

Name	Type	Required	Description
`color`	string	✅	Vehicle color
`plate`	string	⛔	Vehicle plate number
`recipient_name`	string	⛔	Person picking up the order
`parking_location`	string	⛔	Where the car is parked (e.g., zone, space, reference)
`additional_information`	string	⛔	Any other relevant notes to help identify the pickup vehicle

Headers

x-api-key: Your API Key (required)
Content-Type: application/json

Success Response

{
  "message": "CURBSIDE_UPSERT_SUCCESSFULLY"
}

Response Codes

200 OK — Curbside information saved successfully
400 Bad Request — Invariant violation error
404 Not Found — Job not found
422 Unprocessable Entity — Validation errors in the request
500 Internal Server Error — Unexpected server error

Example Error (422)

{
  "errors": [
    {
      "location": "body",
      "param": "color",
      "value": "",
      "msg": "Color is required"
    }
  ]
}