Get Shipment Details

curl -X GET \
  'https://platform.returnqueen.dev/api/shipments/123e4567-e89b-12d3-a456-426614174000' \
  -H 'X-API-KEY: your-api-key'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "order_number": "ORD-12345",
  "shipment_type": "delivery",
  "shipment_date": "2023-11-07T10:00:00Z",
  "complete_at_start": "2023-11-07T14:00:00Z",
  "complete_at_end": "2023-11-07T18:00:00Z",
  "carrier_id": "660e8400-e29b-41d4-a716-446655440000",
  "carrier_service_level_id": "550e8400-e29b-41d4-a716-446655440000",
  "pickup_id": "770e8400-e29b-41d4-a716-446655440000",
  "timezone": "America/New_York",
  "label_url": "https://example.com/labels/123.pdf",
  "metadata": {
    "customer_id": "CUST-123",
    "internal_ref": "REF-456"
  },
  "inserted_at": "2023-11-07T10:00:00Z",
  "updated_at": "2023-11-07T10:00:00Z"
}

GET

api

shipments

{id}

curl -X GET \
  'https://platform.returnqueen.dev/api/shipments/123e4567-e89b-12d3-a456-426614174000' \
  -H 'X-API-KEY: your-api-key'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "order_number": "ORD-12345",
  "shipment_type": "delivery",
  "shipment_date": "2023-11-07T10:00:00Z",
  "complete_at_start": "2023-11-07T14:00:00Z",
  "complete_at_end": "2023-11-07T18:00:00Z",
  "carrier_id": "660e8400-e29b-41d4-a716-446655440000",
  "carrier_service_level_id": "550e8400-e29b-41d4-a716-446655440000",
  "pickup_id": "770e8400-e29b-41d4-a716-446655440000",
  "timezone": "America/New_York",
  "label_url": "https://example.com/labels/123.pdf",
  "metadata": {
    "customer_id": "CUST-123",
    "internal_ref": "REF-456"
  },
  "inserted_at": "2023-11-07T10:00:00Z",
  "updated_at": "2023-11-07T10:00:00Z"
}

Request Parameters

Path Parameters

string

required

The unique identifier of the shipment

curl -X GET \
  'https://platform.returnqueen.dev/api/shipments/123e4567-e89b-12d3-a456-426614174000' \
  -H 'X-API-KEY: your-api-key'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "order_number": "ORD-12345",
  "shipment_type": "delivery",
  "shipment_date": "2023-11-07T10:00:00Z",
  "complete_at_start": "2023-11-07T14:00:00Z",
  "complete_at_end": "2023-11-07T18:00:00Z",
  "carrier_id": "660e8400-e29b-41d4-a716-446655440000",
  "carrier_service_level_id": "550e8400-e29b-41d4-a716-446655440000",
  "pickup_id": "770e8400-e29b-41d4-a716-446655440000",
  "timezone": "America/New_York",
  "label_url": "https://example.com/labels/123.pdf",
  "metadata": {
    "customer_id": "CUST-123",
    "internal_ref": "REF-456"
  },
  "inserted_at": "2023-11-07T10:00:00Z",
  "updated_at": "2023-11-07T10:00:00Z"
}

Response Fields

string

Unique identifier for the shipment (UUID format)

string

Order reference number

string

Type of shipment: delivery, return, or exchange

string

Shipment date in ISO 8601 format

string

Start of pickup window in ISO 8601 format

string

End of pickup window in ISO 8601 format

string

Carrier identifier (UUID format)

string

Carrier service level identifier (UUID format)

string

Pickup identifier (UUID format)

string

IANA timezone identifier

string

URL to the shipping label

object

Additional shipment metadata

string

When the shipment was created (ISO 8601 format)

string

When the shipment was last updated (ISO 8601 format)

Shipments

Availability

Webhooks

Request Parameters

Path Parameters

Response Fields

​Request Parameters

​Path Parameters

​Response Fields

Request Parameters

Path Parameters

Response Fields