Get all purchasable-shipping-labels
Retrieves all avalable shipping labels based on the supplied OrderItem.
GET /services/rest/purchasable-shipping-labels/v2?orderItemId=:id
Parameters
Name | Type | Description |
OrderItemId | integer |
Required. Specifies the article within an Order. Based on the article the result will only contain applicable shipping-labels. |
GET /services/rest/purchasable-shipping-labels/v2?orderItemId=217999480
Example response
Status: 200 OK
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PurchasableShippingLabels xmlns="https://plazaapi.bol.com/services/xsd/v2/plazaapi.xsd">
<Label>
<TransporterCode>DHLFORYOU</TransporterCode>
<LabelType>PARCEL</LabelType>
<MaxWeight>10 kg</MaxWeight>
<MaxDimensions>80 x 40 x 18,75 cm</MaxDimensions>
<RetailPrice>6.00</RetailPrice>
<PurchasePrice>3.62</PurchasePrice>
<Discount>2.38</Discount>
<ShippingLabelCode>PLR00000002</ShippingLabelCode>
</Label>
<Label>
<TransporterCode>TNT</TransporterCode>
<LabelType>MAILBOX</LabelType>
<MaxWeight>2 kg</MaxWeight>
<MaxDimensions>38 x 26,5 x 3,2 cm</MaxDimensions>
<RetailPrice>3.50</RetailPrice>
<PurchasePrice>2.99</PurchasePrice>
<Discount>0.51</Discount>
<ShippingLabelCode>PLR00000011</ShippingLabelCode>
</Label>
<Label>
<TransporterCode>DPD-NL</TransporterCode>
<LabelType>PARCEL</LabelType>
<MaxWeight>20 kg</MaxWeight>
<MaxDimensions>100 x 50 x 50 cm</MaxDimensions>
<RetailPrice>6.25</RetailPrice>
<PurchasePrice>3.62</PurchasePrice>
<Discount>2.63</Discount>
<ShippingLabelCode>PLR00000014</ShippingLabelCode>
</Label>
</PurchasableShippingLabels>
Retrieve a specific shipping-label
Download the specific shipping-label.
GET /services/rest/transports/v2/:transportId/shipping-label/:shippingLabelId
Parameters
Name | Type | Description |
transportId |
integer |
Required. Please enter the TransportId retrieved through GET /services/rest/shipments/v2 belonging to the applicable OrderId . |
shippingLabelId |
integer |
Required. Please enter the ShippingLabelId retrieved through GET /services/rest/shipments/v2 belonging to the applicable OrderId . |
This returns the label as a PDF File.
GET /services/rest/transports/v2/:transport-id/shipping-label/:shipping-label-id
Endpoint XSD
Download XSD for the shipping-labels-v2 endpoint below.
shipping-labels-v2 | https://plazaapi.bol.com/services/xsd/shipping-labels-v2.xsd |