POST /api/v1/shipment/shipment
Creates a new shipment with the selected ShippingproviderServers
- 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 |
|---|---|---|---|
Content |
String | No |
Optional specify a text describing the content of the shipment. Used for export shipments |
PrinterIdForExportDocs |
Integer | No |
The id of a connected Cloudprinter to sent the export docs to |
ProductCode |
String | No |
The productcode to be used when creating the shipment. Values depends on the carrier used |
PrinterName |
String | No |
The name of a connected Cloudprinter to sent the label to |
shippingCarrier |
Integer | No |
Valid values:
|
CustomerNumber |
String | No |
Not used anymore |
Dimension |
Object | No | |
Dimension.height |
Number | No | |
Dimension.length |
Number | No | |
Dimension.width |
Number | No | |
WeightInGram |
Number | No |
Optional specify the weight in gram of the shipment |
ProviderName |
String | No |
The name of the provider as specified in the billbee account |
Services[] |
Array | No |
A list of services to be used when creating the shipment |
Services[].ServiceName |
String | No | |
Services[].RequiresUserInput |
Boolean | No | |
Services[].DisplayName |
String | No | |
Services[].PossibleValueLists[] |
Array | No | |
Services[].PossibleValueLists[].key |
String | No | |
Services[].PossibleValueLists[].value[] |
Array | No | |
Services[].PossibleValueLists[].value[].key |
Integer | No | |
Services[].PossibleValueLists[].value[].value |
String | No | |
Services[].typeName |
String | No | |
Services[].CanBeConfigured |
Boolean | No | |
Services[].DisplayValue |
String | No | |
ReceiverAddress |
Object | No | |
ReceiverAddress.City |
String | No | |
ReceiverAddress.State |
String | No | |
ReceiverAddress.FullName |
String | No | |
ReceiverAddress.Street |
String | No | |
ReceiverAddress.Name2 |
String | No | |
ReceiverAddress.CountryCode |
String | No | |
ReceiverAddress.IsExportCountry |
Boolean | No | |
ReceiverAddress.LastName |
String | No | |
ReceiverAddress.Company |
String | No | |
ReceiverAddress.FirstName |
String | No | |
ReceiverAddress.Email |
String | No | |
ReceiverAddress.AddressAddition |
String | No | |
ReceiverAddress.CountryCodeISO3 |
String | No | |
ReceiverAddress.FullStreet |
String | No | |
ReceiverAddress.Zip |
String | No | |
ReceiverAddress.Housenumber |
String | No | |
ReceiverAddress.Telephone |
String | No | |
ClientReference |
String | No |
Optional specify a text to be included on the label. Not possible with all carriers |
OrderSum |
Number | No |
The value of the shipments content |
ShipDate |
String | No |
Optional overwrite the shipdate to be transferred to the carrier |
OrderCurrencyCode |
String | No |
The Currency if the ordersum |
TotalNet |
Number | No |
The value of the shipments content (net) |
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.