---
title: "Return deliveries list"
method: GET
path: "/ws/shipping/v1/deliveries"
tags: ["Backship"]
---

# Return deliveries list

`GET /ws/shipping/v1/deliveries`

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.

## Query parameters

- `page` integer
- `order_id` integer
- `start_date` string, date-time
- `end_date` string, date-time
- `pickup_start_date` string, date-time
- `pickup_end_date` string, date-time
- `order_state` 0 | 1 | 3 | 8 | 9
- `hub_scanned` boolean

## Response `200`

List of deliveries

- object
  - `count` integer, required — Total number of deliveries
  - `next` string, nullable, required — Url to get the next paginated deliveries list. Null if no next page
  - `previous` string, nullable, required — Url to get the previous paginated deliveries list. Null if no previous page
  - `results` Delivery[], required — List of deliveries
    - `order` integer, required — Order ID
    - `shipmentId` integer, required — Shipment ID
    - `carrierId` integer, required — Carrier ID
    - `orderlines` integer[], required — Orderlines
    - `referenceNumber` string, required — Reference number
    - `trackingNumber` string, required — Tracking number
    - `trackingUrl` string, required — Tracking url
    - `carrierName` string, required — Carrier name
    - `hubScanned` boolean, required — Whether the related shipment label have been scanned
    - `invoicedCurrency` string, required — Invoice currency
    - `invoicedPrice` integer, required — Invoiced amount
    - `datePickup` string, date-time, required — Pickup date
    - `dateCreation` string, date-time, required — Creation date
    - `dateDelivery` string, date-time, required — Delivery date
    - `labelUrl` string, required — Label url
    - `type` string, required — Type of delivery
    - `pickupInfo` PickupInfo, required
      - `confirmationNumber` string, required — Confirmation number
      - `datePickupActual` string, required — Actual pickup date
      - `datePickupRangeStart` string, required — Start date of pickup
      - `datePickupRangeEnd` string, required — End date of pickup
      - `datePickupRequested` string, required — Requested date for pickup
      - `isCanceled` boolean, required — Pickup cancellation state
      - `pickupId` integer, required — Pickup ID

## Other responses

- `422` — Unprocessable Entity

---

[API](https://skmtc.net/backmarket/apis/back-market-api-guidelines.md) · [All operations](https://skmtc.net/backmarket/apis/back-market-api-guidelines/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/backmarket/back-market-api-guidelines/revisions/6a1303364143/schema)