Skip to main content
POST
/
orders
/
check
/
{locationId}
Check order
curl --request POST \
  --url https://staging-v2.sparqle.tech/orders/check/{locationId} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "deliveryAddress": {
    "street": "Gustav Mahlerlaan",
    "houseNumber": "320",
    "postalCode": "1082 ME",
    "city": "Amsterdam",
    "suffix": "",
    "countryCode": "NL"
  },
  "dimensions": {
    "length": 200,
    "width": 75,
    "height": 50
  },
  "weight": 1500,
  "signature": false,
  "notAtNeighbour": false
}
'
{
  "statusCode": 400,
  "message": [
    "deliveryName should not be empty"
  ],
  "error": "Bad Request"
}

Authorizations

api-key
string
header
required

Path Parameters

locationId
string
required

Body

application/json
deliveryAddress
object
required
dimensions
object

Collo dimensions in mm. Must satisfy length >= width >= height.

weight
number

Weight in grams.

Example:

1500

signature
boolean

Delivery requires a signature.

Example:

false

notAtNeighbour
boolean

Do not deliver to a neighbour.

Example:

false

Response

Validation result