BAbackmarket
Backship

Return deliveries list

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

Request

Query parameters

pageinteger

Page number

order_idinteger

Order ID

start_datestring date-time

Get deliveries created at and after this datetime

end_datestring date-time

Get deliveries created before and at this datetime

pickup_start_datestring date-time

Get deliveries picked up at and after this datetime

pickup_end_datestring date-time

Get deliveries picked up before and at this datetime

order_state0 | 1 | 3 | 8 | 9

State of the order

hub_scannedboolean

Whether shipments label have been scanned

Response

List of deliveries

countinteger required

Total number of deliveries

nextstring nullable required

Url to get the next paginated deliveries list. Null if no next page

previousstring nullable required

Url to get the previous paginated deliveries list. Null if no previous page

Example response

{
  "count": 42,
  "next": "https://preprod.backmarket.fr/ws/shipping/v1/deliveries?page=2",
  "previous": "https://preprod.backmarket.fr/ws/shipping/v1/deliveries?page=1",
  "results": [
    {
      "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