Skip to main content
GET
/
v1
/
retailers
/
{retailer_id}
/
shipments
List fulfillments or shipments from vendors
curl --request GET \
  --url https://marketplace-api.fabric.inc/v1/retailers/{retailer_id}/shipments/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 600,
  "results": [
    {
      "order_id": 677,
      "id": 767,
      "batch_number": 6,
      "label_reference": "Sample label 123",
      "ordered_at": "2021-09-10T15:24:56Z",
      "customer_order_number": "765637",
      "retailer_order_number": "66367",
      "purchase_order_number": "PO-576",
      "tracking_number": "1Z9999999999999988",
      "tracking_url": "https://wwwapps.demo.com/WebTracking/track?track=yes&trackNums=1Z9999999999999988",
      "tracking": {
        "picked_up_at": "2022-08-10T15:24:56Z",
        "delivered_at": "2022-09-10T15:24:56Z",
        "tracking_details": [
          {
            "status": "Delivered",
            "status_detail": "Out for delivery",
            "id": 78895456,
            "time": "10-10-2022",
            "country": "USA",
            "state": "New York",
            "city": "New York",
            "postal_code": "123R32"
          }
        ]
      },
      "status": "Shipped",
      "is_acknowledged": true,
      "has_commercial_invoice": true,
      "canceled_at": null,
      "ship_weight": 10,
      "ship_width": 1,
      "ship_length": 1,
      "ship_height": 1,
      "ship_girth": "<string>",
      "ship_volume": 4,
      "valid_packing_slip": true,
      "valid_shipping_label": true,
      "shipping_provider_identifier": "shp_3a61e10243da49ab92f0e3861d5d256b",
      "error_logs": {
        "id": 677,
        "message": "Sample errors to fix",
        "count": 12,
        "created_at": "2022-08-10T15:24:56Z"
      },
      "acknowledged_at": "2022-08-10T15:24:56Z",
      "closed_at": null,
      "delivered_at": "2022-09-10T15:24:56Z",
      "shipped_at": "2022-09-10T15:24:56Z",
      "updated_at": "2022-09-10T15:25:56Z",
      "created_at": "2022-09-10T15:24:56Z",
      "shipment_lines": [
        {
          "id": 1001,
          "order_line_number": "1001",
          "quantity": 1,
          "part": 1,
          "freight_class": 50,
          "updated_at": "2022-09-10T15:24:56Z",
          "variant": {
            "id": 249,
            "name": "Var45",
            "identifier": "123-DEF12345",
            "brand_identifier": "HATR",
            "upc": 555555555202,
            "retailer_identifiers": [
              {
                "id": 5642,
                "identifier": "SKU976",
                "name": "Retailer Sample"
              }
            ]
          }
        }
      ],
      "signature": null,
      "invoice_number": "RC123456"
    }
  ],
  "next": "https://api.example.org/demo/{retailer_id}/?page=5",
  "previous": "https://api.example.org/demo/{retailer_id}/?page=3"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
retailer_id
number
required

The unique retailer ID. In the Dropship UI this is called the Merchant ID. To find your Merchant ID, click your merchant name in the top nav.

Query Parameters

​
status
string

Shipment status

​
is_acknowledged
number

1: shipment is picked up | 0: shipment is not picked up

​
search
string

Search by tracking or purchase order number

​
order_id
number[]

Order IDs. Multiple values may be separated by commas.

​
since
number

Past date till current (Unix epoch format)

​
connection_id
number[]

Connection ID. Multiple values may be separated by commas.

​
order_by
string

Sorting preference

​
page
integer

Page number within the paginated result set

​
limit
integer

Number of records per page

Response

200 - application/json

OK

​
count
integer
required

Total number of records

Example:

600

​
results
object[]
required
​
next
string<uri> | null

Next page (applicable in a paginated response)

Example:

"https://api.example.org/demo/{retailer_id}/?page=5"

​
previous
string<uri> | null

Previous page (applicable in a paginated response)

Example:

"https://api.example.org/demo/{retailer_id}/?page=3"