Wocart
Wocart API

Shipping Labels

Server

Get the shipping-label settings

GET
https://api.wocart.store
/api/shipping-labels/settings
X-API-Key (header)

How the store's labels for its own drivers look, and the sender they print. A store that never set them gets the defaults.

Get the shipping-label settings › Responses

200

The settings

success
​boolean · required
​object · required

Replace the shipping-label settings

PUT
https://api.wocart.store
/api/shipping-labels/settings
X-API-Key (header)

Replaces the whole settings: a key you omit takes its default. Unknown keys are refused rather than ignored, and every problem is reported at once in context.issues (path, code). Saving the defaults stores nothing (the column goes back to NULL).

Replace the shipping-label settings › Request Body

A ShippingLabelConfig with every key optional
No data returned

Replace the shipping-label settings › Responses

The saved settings

success
​boolean · required
​object · required

A driver's delivery sheet

GET
https://api.wocart.store
/api/shipping-labels/delivery-sheet/{driverId}
X-API-Key (header)

Every parcel still out with the driver — not delivered, returned or cancelled — in the order they were given, with the cash each has to collect and the total, read in one trip.

A driver's delivery sheet › path Parameters

driverId
​string · minLength: 1 · required

A driver's delivery sheet › Responses

The delivery sheet

success
​boolean · required
​object · required

The labels of driver shipments

POST
https://api.wocart.store
/api/shipping-labels
X-API-Key (header)

Everything the labels of up to 100 driver shipments print, read in one trip: the settings, the sender, and each parcel — the customer, the place, the cash to collect, the lines, the notes and the driver — in the order asked. A carrier prints its own label (GET /shipments/{id}/label), so a carrier shipment, like an unknown id, is listed in missing. A read: nothing is written.

The labels of driver shipments › Request Body

shipmentIds
​string[] · minItems: 1 · maxItems: 100 · required

The labels of driver shipments › Responses

200

The labels

success
​boolean · required
​object · required