POST /api/v1/orders/{id}/shipment
Add a shipment to a given orderServers
- https://app.billbee.io
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | Yes |
The internal billbee id of the order |
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 |
|---|---|---|---|
ShippingId |
String | No |
The id of the shipment (Sendungsnummer/trackingid) |
ShippingProviderProductId |
Integer | No |
Optional the id of a shipping provider product that should be assigend to the shipment |
ShippingProviderId |
Integer | No |
Optional the id of a shipping provider existing in the billbee account that should be assigned to the shipment |
CarrierId |
Integer | No |
Optional the id of a shipping carrier that should be assigend to the shipment Will override the carrier from the shipment product. Please use the integer value from this Enumeration: {Billbee.Interfaces.Shipping.Enums.ShippingCarrier} |
Comment |
String | No |
Optional a text stored with the shipment |
OrderId |
String | No |
Optional a differing order number of the shipment if available |
ShipmentType |
Integer | No |
0 if Shipment, 1 if Retoure {Billbee.Interfaces.Shipping.Enums.ShipmentTypeEnum} |
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.