Shipments -- OpenBusinessAPI

Shipments

Delivery / despatch advice. Represents goods shipped to the customer.

List shipments

Method: GET /obapi/v1/shipments
Headers: Authorization: Bearer {apikey}

Parameter	Type	Required	Description
`page`	integer	no	Page number (default: 1)
`per_page`	integer	no	Items per page (default: 50, max: 200)
`date_start`	string	no	From date (YYYY-MM-DD)
`date_end`	string	no	To date (YYYY-MM-DD)
`status`	string	no	`draft`, `validated`, `closed`
`sort`	string	no	`date_asc`, `date_desc` (default), `ref_asc`, `ref_desc`

Get a single shipment

Method: GET /obapi/v1/shipments/{id}

Response (single)

{
    "shipment": {
        "id": "42",
        "ref": "EX2405-0003",
        "customer_ref": "",
        "date_shipment": "2024-05-20",
        "date_delivery": "2024-05-22",
        "validated_at": "2024-05-20T08:00:00Z",
        "created_at": "2024-05-19T16:00:00Z",
        "updated_at": "2024-05-20T08:00:00Z",
        "status": "validated",
        "order_ref": "CO2405-0018",
        "tracking_number": "6A12345678",
        "tracking_url": "https://tracking.example.com/6A12345678",
        "shipping_method": "Colissimo",
        "weight": "2.500",
        "weight_units": "kg",
        "billed": false,
        "public_note": "",
        "lines": [
            {
                "id": "85",
                "product_ref": "WIDGET-01",
                "product_label": "Widget standard",
                "quantity": "10.00",
                "warehouse": "Main warehouse",
                "position": 1
            }
        ]
    }
}

Download PDF

GET /obapi/v1/download/{id}?type=shipment