v4 - Shipping labels - Demo Endpoints
Request a shipping label for a shipping label offer id.
Use a shippable configuration of a number of order items and a shipping label offer id to request a shipping label.
POST /retailer-demo/shipping-labels
Accept: application/vnd.retailer.v4+json
Content-Type: application/vnd.retailer.v4+json
Authorization: Bearer token (omitted)
{
"orderItems" : [ {
"orderItemId" : "2095052647"
} ],
"shippingLabelOfferId" : "8f956bfc-fabe-45b4-b0e1-1b52a0896b74"
}Content-Type: application/vnd.retailer.v4+json
Status: 202 ACCEPTED
{
"id" : 1,
"eventType" : "CREATE_SHIPPING_LABEL",
"description" : "Create shipping label with shipping label offer id 8f956bfc-fabe-45b4-b0e1-1b52a0896b74.",
"status" : "PENDING",
"createTimestamp" : "2021-06-23T10:11:09+02:00",
"links" : [ {
"rel" : "self",
"href" : "http://api.bol.com/retailer-demo/process-status/1",
"method" : "GET"
} ]
}Get VVB delivery options for a shippable configuration
Endpoint returns delivery options for a shippable configuration of a number of order items belonging to an open order. A delivery options contains a shipping label offer id which you can use to request a shipping label.
POST /retailer-demo/shipping-labels/delivery-options
Accept: application/vnd.retailer.v4+json
Content-Type: application/vnd.retailer.v4+json
Authorization: Bearer token (omitted)
{
"orderItems" : [ {
"orderItemId" : "2095052647"
} ]
}Content-Type: application/vnd.retailer.v4+json
Status: 200 OK
{
"deliveryOptions" : [ {
"shippingLabelOfferId" : "32c4a88c-3c64-41ad-83a1-24450b341747",
"validUntilDate" : "2020-10-17",
"transporterCode" : "TNT",
"labelType" : "PARCEL",
"labelPrice" : {
"totalPrice" : 4.41
},
"packageRestrictions" : {
"maxWeight" : "10 kg",
"maxDimensions" : "100 x 50 x 50 cm"
},
"handoverDetails" : {
"meetsCustomerExpectation" : true,
"latestHandoverDateTime" : "2020-10-03T18:00:00+02:00",
"collectionMethod" : "DROP_OFF"
}
}, {
"shippingLabelOfferId" : "fb7f20c0-d847-4d62-9c57-7aba64fb9b52",
"validUntilDate" : "2020-10-08",
"transporterCode" : "TNT_BRIEF",
"labelType" : "MAILBOX_LIGHT",
"labelPrice" : {
"totalPrice" : 2.88
},
"packageRestrictions" : {
"maxWeight" : "2 kg",
"maxDimensions" : "38 x 26,5 x 3,2 cm"
},
"handoverDetails" : {
"meetsCustomerExpectation" : true,
"latestHandoverDateTime" : "2020-09-24T18:30:00+02:00",
"collectionMethod" : "DROP_OFF"
}
} ]
}Get delivery options for a shippable configuration
Endpoint returns delivery options for a shippable configuration of a number of order items belonging to an open order. A delivery options contains a shipping label offer id which you can use to request a shipping label.
POST /retailer-demo/shipping-labels/delivery-options
Accept: application/vnd.retailer.v4+json
Content-Type: application/vnd.retailer.v4+json
Authorization: Bearer token (omitted)
{
"orderItems" : [ {
"orderItemId" : "2096224434"
} ]
}Content-Type: application/vnd.retailer.v4+json
Status: 200 OK
{
"deliveryOptions" : [ {
"shippingLabelOfferId" : "c29afac7-9700-4818-b654-97d1d334999c",
"validUntilDate" : "2020-10-12",
"transporterCode" : "TNT_BRIEF",
"labelType" : "MAILBOX_LIGHT",
"labelPrice" : {
"totalPrice" : 2.88
},
"packageRestrictions" : {
"maxWeight" : "2 kg",
"maxDimensions" : "38 x 26,5 x 3,2 cm"
}
}, {
"shippingLabelOfferId" : "7d3205e2-7ac1-40ca-a52f-952066b57353",
"validUntilDate" : "2020-10-12",
"transporterCode" : "TNT",
"labelType" : "MAILBOX",
"labelPrice" : {
"totalPrice" : 3.9
},
"packageRestrictions" : {
"maxWeight" : "2 kg",
"maxDimensions" : "38 x 26,5 x 3,2 cm"
}
}, {
"shippingLabelOfferId" : "da28efa7-243c-444e-b74f-be21bc2dfa71",
"validUntilDate" : "2020-10-12",
"transporterCode" : "DPD-NL",
"labelType" : "PARCEL",
"labelPrice" : {
"totalPrice" : 4.79
},
"packageRestrictions" : {
"maxWeight" : "20 kg",
"maxDimensions" : "100 x 50 x 50 cm"
}
}, {
"shippingLabelOfferId" : "06636e98-e26a-4747-8ad2-786fa8a514c6",
"validUntilDate" : "2020-10-12",
"transporterCode" : "DHLFORYOU",
"labelType" : "PARCEL",
"labelPrice" : {
"totalPrice" : 4.69
},
"packageRestrictions" : {
"maxWeight" : "20 kg",
"maxDimensions" : "80 x 50 x 35 cm"
}
}, {
"shippingLabelOfferId" : "aea9abd0-9e20-424d-954a-d01585b23559",
"validUntilDate" : "2020-10-12",
"transporterCode" : "TNT",
"labelType" : "PARCEL",
"labelPrice" : {
"totalPrice" : 6.65
},
"packageRestrictions" : {
"maxWeight" : "10 kg",
"maxDimensions" : "100 x 50 x 50 cm"
}
} ]
}Get metadata headers for a shipping label
This HEAD request does not return any data, but will return the headers for the get request, amongst which the track and trace, transporter and content-disposition headers.
HEAD /retailer-demo/shipping-labels/c628ba4f-f31a-4fac-a6a0-062326d0dbbd
Accept: application/vnd.retailer.v4+pdf
Content-Type: N/A
Authorization: Bearer token (omitted)
This endpoint has no request body.Content-Type: None
Content-Disposition: attachment; filename=ShippingLabel_c628ba4f-f31a-4fac-a6a0-062326d0dbbd.pdf
Content-Length: 0
X-Transporter-Code: TNT
X-Track-And-Trace-Code: 3SBLCQ928933678
Status: 200 OK
This endpoint has no response body.Get a shipping label for an existing shipping label id
Note: demo endpoint doesn’t return a PDF file but a fake, as this is not supported.
GET /retailer-demo/shipping-labels/c628ba4f-f31a-4fac-a6a0-062326d0dbbd
Accept: application/vnd.retailer.v4+pdf
Content-Type: N/A
Authorization: Bearer token (omitted)
This endpoint has no request body.Content-Type: application/vnd.retailer.v4+pdf
Status: 200 OK
THIS IS A FAKE PDF FILE AND IS INTENDED FOR TESTING PURPOSES ONLY. For more information check our documentation on https://developers.bol.com