Receptions

Goods received from a supplier (receipt advice). The counterpart of shipments on the purchasing side.

Endpoints

• GET /obapi/v1/receptions -- list
• GET /obapi/v1/receptions/{id} -- single with lines
• GET /obapi/v1/download/{id}?type=reception -- PDF

Parameters

page, per_page, date_start, date_end, status, sort

Status values

Response (list)

{
    "items": [
        {
            "id": "95",
            "ref": "REC2405-0004",
            "supplier_ref": "SHIP-2024-321",
            "date_reception": "2024-05-25",
            "status": "validated",
            "tracking_number": "1Z999AA10123456784",
            "billed": false
        }
    ],
    "pagination": { "..." }
}

Response (single)

{
    "reception": {
        "id": "95",
        "ref": "REC2405-0004",
        "supplier_ref": "SHIP-2024-321",
        "date_reception": "2024-05-25",
        "date_delivery": "2024-05-24",
        "validated_at": "2024-05-25T08:30:00Z",
        "created_at": "2024-05-24T16:00:00Z",
        "updated_at": "2024-05-25T08:30:00Z",
        "status": "validated",
        "billed": false,
        "origin_type": "supplier_order",
        "origin_id": "120",
        "tracking_number": "1Z999AA10123456784",
        "tracking_url": "https://tracking.example.com/1Z999AA10123456784",
        "shipping_method": "UPS Standard",
        "weight": "12.50",
        "weight_units": "kg",
        "public_note": "",
        "lines": [
            {
                "id": "210",
                "position": 1,
                "product_ref": "COMP-A1",
                "product_label": "Component A1",
                "quantity": "100.00",
                "warehouse": "Main warehouse",
                "comment": ""
            },
            {
                "id": "211",
                "position": 2,
                "product_ref": "COMP-B2",
                "product_label": "Component B2",
                "quantity": "50.00",
                "warehouse": "Main warehouse",
                "comment": "Partial delivery, 50 remaining"
            }
        ]
    }
}

Download PDF

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