GET /delivery-receipts

Récupère la liste des bons de livraison avec pagination, tri et filtres.

Filtres disponibles:

  • state: État du bon de livraison
  • client: ID du client
  • minDate / maxDate: Plage de dates

Réponse:

  • receipts: Liste des bons de livraison
  • total: Nombre total
  • skip et limit: Paramètres de pagination

Query parameters

  • limit integer

    Nombre maximum de bons à retourner

    Default value is 20.

  • skip integer

    Nombre de bons à ignorer (pagination)

    Default value is 0.

  • sort string

    Champ de tri et direction

  • state string

    Filtre par état

    Values are draft, waiting, shipped, delivered, refused, canceled, or inactive.

  • client string

    Filtre par ID du client

Responses

  • 200 application/json

    Liste des bons de livraison

    Hide response attributes Show response attributes object
    • receipts array[object]
      Hide receipts attributes Show receipts attributes object
      • _id string

        Unique identifier for the delivery receipt

      • client string

        Reference to the client

      • client_name string

        Name of the client

      • client_contact string

        Contact person at the client

      • client_email string

        Email of the client

      • client_mobile string

        Mobile phone of the client

      • comment string

        Additional comments

      • company string

        Reference to the company

      • company_name string

        Name of the company

      • date string(date-time)

        Date of the delivery receipt

      • delivery_address string

        Delivery address

      • delivery_city string

        Delivery city

      • delivery_country string

        Delivery country

      • delivery_zip_code string

        Delivery zip code

      • delivery_date string

        Delivery date

      • fromInvoice string

        Reference to the invoice if created from an invoice

      • fromQuote string

        Reference to the quote if created from a quote

      • lines array[object]

        List of delivery receipt lines

        Hide lines attributes Show lines attributes object
        • description string

          Description of the line

        • quantity number

          Quantity

          Default value is 1.

        • reference string

          Reference of the product

        • title string

          Title of the line

        • type string

          Type of the line

          Values are product or header. Default value is product.

        • weight number

          Weight of the product

      • number string

        Receipt number

      • numberOrder string

        Order number

      • notes string

        Additional notes

      • shipping_date string(date-time)

        Shipping date

      • shipping_method string

        Shipping method

      • shippingNbPackages number

        Number of packages

      • state string

        State of the delivery receipt

        Values are draft, waiting, shipped, delivered, refused, canceled, or inactive. Default value is draft.

      • title string

        Short description or label of the delivery receipt

      • totalWeight number

        Total weight of all products

      • totalQuantity number

        Total quantity of all products

        Default value is 0.

      • type string

        Type of the receipt

        Value is delivery. Default value is delivery.

    • total integer
    • skip integer
    • limit integer
GET /delivery-receipts
curl \
 --request GET 'https://wuro.pro/api/v3.2/delivery-receipts' \
 --header "X-APP-ID: $API_KEY" \
 --header "X-APP-SECRET: $API_KEY"
Response examples (200)
{
  "receipts": [
    {
      "_id": "string",
      "client": "string",
      "client_name": "string",
      "client_contact": "string",
      "client_email": "string",
      "client_mobile": "string",
      "comment": "string",
      "company": "string",
      "company_name": "string",
      "date": "2025-05-04T09:42:00Z",
      "delivery_address": "string",
      "delivery_city": "string",
      "delivery_country": "string",
      "delivery_zip_code": "string",
      "delivery_date": "string",
      "fromInvoice": "string",
      "fromQuote": "string",
      "lines": [
        {
          "description": "string",
          "quantity": 1,
          "reference": "string",
          "title": "string",
          "type": "product",
          "weight": 42.0
        }
      ],
      "number": "string",
      "numberOrder": "string",
      "notes": "string",
      "shipping_date": "2025-05-04T09:42:00Z",
      "shipping_method": "string",
      "shippingNbPackages": 42.0,
      "state": "draft",
      "title": "string",
      "totalWeight": 42.0,
      "totalQuantity": 0,
      "type": "delivery"
    }
  ],
  "total": 42,
  "skip": 42,
  "limit": 42
}