> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sparqle.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Check order

> Validate a delivery address and serviceability for a location before creating an order.



## OpenAPI

````yaml /api-reference/openapi.json post /orders/check/{locationId}
openapi: 3.1.0
info:
  title: Sparqle API
  version: 1.0.0
  description: >-
    Create deliveries, fetch shipping labels, and track orders with Sparqle.


    This specification is a hand-authored starting point derived from the API
    source. Replace or merge it with the spec exported from your previous docs
    as you refine the reference.
servers:
  - url: https://staging-v2.sparqle.tech
    description: Test
  - url: https://v2.sparqle.com
    description: Live
security:
  - apiKey: []
paths:
  /orders/check/{locationId}:
    post:
      tags:
        - Orders
      summary: Check order
      description: >-
        Validate a delivery address and serviceability for a location before
        creating an order.
      operationId: checkOrder
      parameters:
        - name: locationId
          in: path
          required: true
          schema:
            type: string
          example: ABC123
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckOrder'
      responses:
        '200':
          description: Validation result
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    CheckOrder:
      type: object
      required:
        - deliveryAddress
      properties:
        deliveryAddress:
          $ref: '#/components/schemas/Address'
        dimensions:
          type: object
          description: Collo dimensions in mm. Must satisfy length >= width >= height.
          properties:
            length:
              type: number
              example: 200
            width:
              type: number
              example: 75
            height:
              type: number
              example: 50
        weight:
          type: number
          description: Weight in grams.
          example: 1500
        signature:
          type: boolean
          description: Delivery requires a signature.
          example: false
        notAtNeighbour:
          type: boolean
          description: Do not deliver to a neighbour.
          example: false
    Address:
      type: object
      required:
        - street
        - houseNumber
        - postalCode
        - city
      properties:
        street:
          type: string
          example: Gustav Mahlerlaan
        houseNumber:
          type: string
          example: '320'
        suffix:
          type: string
          example: ''
        postalCode:
          type: string
          example: 1082 ME
        city:
          type: string
          example: Amsterdam
        countryCode:
          type: string
          example: NL
    Error:
      type: object
      properties:
        statusCode:
          type: integer
          example: 400
        message:
          type: array
          items:
            type: string
          example:
            - deliveryName should not be empty
        error:
          type: string
          example: Bad Request
  responses:
    ValidationError:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid API key
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: api-key

````