GuideLab Docs
Orders

What a new shipment for an order can carry

Lab only. The order's shipping group, or the order alone, with each physical line's quantity not yet on a live shipment, the shipping method the clinic chose and the default destination.

GET
/orders/{id}/shipment-candidates

Lab only. The order's shipping group, or the order alone, with each physical line's quantity not yet on a live shipment, the shipping method the clinic chose and the default destination.

Authorization

__Secure-guidelab-prod.session_token<token>

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

In: cookie

Path Parameters

id*string
Length1 <= length

Response Body

application/json

curl -X GET "https://example.com/orders/string/shipment-candidates"
{  "partnershipId": "string",  "partnershipActive": true,  "method": "carrier",  "clinicLocationId": "string",  "clinicAddress": {    "name": "string",    "addressLine1": "string",    "addressLine2": "string",    "city": "string",    "region": "string",    "postcode": "string",    "country": "string",    "contactPhone": "string"  },  "orders": [    {      "id": "string",      "orderNumber": "string",      "status": "draft",      "shippable": true,      "items": [        {          "id": "string",          "productName": "string",          "quantity": 1,          "remainingQuantity": 0        }      ]    }  ],  "truncated": true}
Empty
Empty
Empty

Find original orders for the same client and active reasons GET

Previous Page

Quote the shipping options for an order GET

Prices each shipping type the lab offers for this order's destination and weight, exactly as submission will freeze it, with the open orders it may ship together with. For a draft, the organization that owns it may ask; for a submitted order, only the lab while it can still change the order's shipping. Missing product weights and an uncovered destination are reported to the lab only.