POST /api/v1/shipment/shipwithlabel
Creates a shipment for an order in billbeeServers
- https://app.billbee.io
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
ChangeStateToSend |
Boolean | No |
Optional parameter to automatically change the orderstate to sent after creating the shipment |
Dimension |
Object | No | |
Dimension.height |
Number | No | |
Dimension.length |
Number | No | |
Dimension.width |
Number | No | |
WeightInGram |
Integer | No |
Optional the shipments weight in gram to override the calculated weight |
OrderId |
Integer | No |
The Billbee internal id of the order to ship |
PrinterName |
String | No |
Optional the name of a connected cloudprinter to send the label to |
ProviderId |
Integer | No |
The id of the provider. You can query all providers with the shippingproviders endpoint |
ClientReference |
String | No |
Optional specify a reference text to be included on the label. Works not with all carriers |
ShipDate |
String | No |
Optional specify the shipdate to be transmitted to the carrier |
ProductId |
Integer | No |
the id of the shipping provider product to be used |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.