BAbackmarket
Backship

Return details about a specific delivery

Changed on

This API is for merchants who are subscribed to the BackShip service.

Once an orderline has been accepted via the Orderline API, a shipping label is automatically created corresponding to this orderline and can be retrieved from this endpoint via the field labelUrl. The state of the orderline must be updated once the product has been shipped.

get/ws/shipping/v1/deliveries/{id}

Request

Path parameters

idinteger required

Delivery ID

Response

Delivery details

orderinteger required

Order ID

shipmentIdinteger required

Shipment ID

carrierIdinteger required

Carrier ID

orderlinesinteger[] required

Orderlines

referenceNumberstring required

Reference number

trackingNumberstring required

Tracking number

trackingUrlstring required

Tracking url

carrierNamestring required

Carrier name

hubScannedboolean required

Whether the related shipment label have been scanned

invoicedCurrencystring required

Invoice currency

invoicedPriceinteger required

Invoiced amount

datePickupstring date-time required

Pickup date

dateCreationstring date-time required

Creation date

dateDeliverystring date-time required

Delivery date

labelUrlstring required

Label url

typestring required

Type of delivery

Example response

{
  "order": 42,
  "shipmentId": 42,
  "carrierId": 42,
  "orderlines": [
    42
  ],
  "referenceNumber": "1",
  "trackingNumber": "Jc2rnTAc4L",
  "trackingUrl": "https://carrier.com/tracking/Jc2rnTAc4L",
  "carrierName": "Chronopost",
  "invoicedCurrency": "EUR",
  "invoicedPrice": 30,
  "datePickup": "2021-05-05T06:58:31+02:00",
  "dateCreation": "2021-05-05T06:58:31+02:00",
  "dateDelivery": "2021-05-05T06:58:31+02:00",
  "labelUrl": "/static/shipment_labels/eu-9075b45c-d736-4e51-83ec-3f2ae2888e3e-1.pdf",
  "type": "DELIVERY",
  "pickupInfo": {
    "confirmationNumber": "1231NB",
    "datePickupActual": "2021-05-05T06:58:31+02:00",
    "datePickupRangeStart": "2021-05-05T06:58:31+02:00",
    "datePickupRangeEnd": "2021-05-05T06:58:31+02:00",
    "datePickupRequested": "2021-05-05",
    "pickupId": 42
  }
}

Changes

  • e148c36fefb6Revision changes
    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      the endpoint scheme security BasicAuth was added to the API