GuideLab Docs
Orders

Change a submitted order's shipping

Lab only. Sets the shipping type, insurance and combined shipment of an open order that is not yet paid or invoiced, re-pricing only this order from the current rate table. A null shipping type removes the charge. Orders that others have joined keep their shipping type.

PUT
/orders/{id}/shipping

Lab only. Sets the shipping type, insurance and combined shipment of an open order that is not yet paid or invoiced, re-pricing only this order from the current rate table. A null shipping type removes the charge. Orders that others have joined keep their shipping type.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/orders/string/shipping" \  -H "Content-Type: application/json" \  -d '{    "shippingTypeId": "string",    "shippingInsured": true,    "shipWithOrderId": "string"  }'
{  "shipping": {    "shippingTypeId": "string",    "name": "string",    "method": "carrier",    "amount": "string",    "insuranceAmount": "string",    "totalAmount": "string",    "group": {      "anchorOrderId": "string",      "orders": [        {          "id": "string",          "orderNumber": "string",          "status": "draft"        }      ]    }  },  "shippingLab": {    "weightGrams": 0,    "missingWeightCount": 0,    "zoneName": "string",    "notCharged": true,    "editable": true  }}
Empty
Empty
Empty
Empty

Update a line item on an existing order PATCH

Updates the configuration of an existing draft line item and re-resolves authoritative pricing. Price-affecting fields are frozen after submission.

Update order status PATCH

Transitions an existing submitted order with validation of allowed transitions. Draft submission is owned exclusively by POST /orders/:id/submit so phase materialization and promotion remain atomic.