GuideLab Docs
Shipments

List outbound shipments visible to the active organization

GET
/shipments

Authorization

__Secure-guidelab-prod.session_token<token>

Production session cookie set for the guidelab.co domain by Better Auth

In: cookie

Query Parameters

status?string

Value in

  • "draft"
  • "packing"
  • "ready"
  • "in_transit"
  • "delivery_exception"
  • "delivered"
  • "returned"
  • "cancelled"
partnershipId?string
Length1 <= length
orderId?string
Length1 <= length
page?integer
Range0 < value
Default1
limit?integer
Range0 < value <= 100
Default25

Response Body

application/json

curl -X GET "https://example.com/shipments"
{  "data": [    {      "id": "string",      "labId": "string",      "clinicId": "string",      "partnershipId": "string",      "shipmentNumber": 1,      "method": "carrier",      "status": "draft",      "version": 1,      "destinationSource": "one_off",      "destinationLocationId": "string",      "destinationName": "string",      "city": "string",      "region": "string",      "postcode": "string",      "country": "string",      "scheduledDate": "string",      "dispatchedAt": "string",      "deliveredAt": "string",      "returnedAt": "string",      "cancelledAt": "string",      "createdAt": "string",      "updatedAt": "string"    }  ],  "pagination": {    "page": 1,    "limit": 1,    "total": 0,    "totalPages": 0  }}
Empty

Get durable provider operation status GET

Previous Page

Purchase a ShipStation label from a signed rate POST

Next Page