« All modules

AWB

Air WayBill — attach couriers' AWBs to sales.

Filters on list endpoints are URL path segments, not query strings — see Conventions. The Swagger tester works best for JSON body endpoints.
GET /awb/list/ List AWBs

Returns a paginated list of AWBs.

Standard filters: year, yearmonth, yearmonthday, date, modifiedafter, modifiedthrough, id, minid, page.

Custom filter:
- documentnr — filter by AWB tracking number.

Responses

StatusDescription
200 OK — response uses the shared envelope.
GET /awb/add/ Sample body for POST /awb/add/

Returns a schema/example payload for the POST call and lists the accepted courier codes.

Responses

StatusDescription
200 Schema/example (text/html).
POST /awb/add/ Register / attach AWBs to sales (batch)

Attaches one or more already-issued AWBs to existing sales. Use when the AWB was generated in a third-party system (broker, courier portal) and you want BOCP to know about it.

Request body (JSON)

{
    "awbs": [
        {
            "sale_id": 3,
            "awb_nr": "11111",
            "awb_type": "fancurier",
            "awb_subtype": "",
            "awb_url": "https://domain.ro/url"
        },
        {
            "sale_id": 4,
            "awb_nr": "222222",
            "awb_type": "innoship",
            "awb_subtype": "fancurier",
            "awb_url": "https://domain.ro/url"
        }
    ]
}

Responses

StatusDescription
200 OK — response uses the shared envelope.
400 Request is malformed or a required field is missing / invalid.
DELETE /awb/{awb_id}/ Delete an AWB attached to a sale

Parameters

NameInTypeRequiredDescription
awb_id path integer yes

Responses

StatusDescription
200 OK — response uses the shared envelope.
404 The requested resource does not exist.
GET /awb/issue/ Placeholder (not implemented)

Planned endpoint for issuing an AWB from BOCP based on a sale. Not implemented yet.

Responses

StatusDescription
501 Not implemented.

This page is generated from openapi.json.