Check order

post

https://staging-v2.sparqle.tech/orders/check/{locationId}

This endpoint is used to check whether an other with the specified address and constraints can be delivered for your location

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📦 Dimension Convention

When specifying package dimensions, we follow a standardized order to avoid confusion:

📦
Length ≥ Width ≥ Height

Length: the longest side of the package
Width: the middle-sized side
Height: the shortest side (typically vertical when the package is upright)

This ordering ensures consistent validation across systems and carriers.
Please make sure to sort dimensions accordingly before sending them in the request.

If dimensions are not ordered correctly, your package may be incorrectly rejected.

Path Params

locationId

string

required

Your locationId, which can be found in the dashboard in Settings -> API

Body Params

deliveryAddress

json

required

Defaults to { "street": "IJsbaanpad", "houseNumber": "2", "suffix": "", "postalCode": "1076CV", "city": "Amsterdam", "countryCode": "NL" }

Where only suffix is optional

dimensions

json

Defaults to { "length": 600, "width": 400, "height": 400 }

Dimensions of the parcel in mm, where length >= width >= height

weight

float

Weight of the parcel in grams

signature

boolean

Defaults to false

Does this order require a signature on delivery?

notAtNeighbour

boolean

Defaults to false

Does this order allow a delivery at neighbour if recipient not at home?

Responses

📦 Dimension Convention

📦Length ≥ Width ≥ Height

200200

400400

📦
Length ≥ Width ≥ Height