Change the status of a shipment in the authenticated account. Shipment, parent order and target status must belong to this account; missing or foreign resources return 404.
Updates the current status of a shipment to the specified next status.
Path Parameters
Shipment ID
Header Parameters
Your API Key for authentication
Request Body
application/json
Only status_id; the shipment ID comes from the route
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/v1/shipments/string/status" \ -H "X-Api-Key: string" \ -H "Content-Type: application/json" \ -d '{}'{ "shipment": { "id": "string", "accountId": "string", "orderId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "statusUpdatedAt": "2019-08-24T14:15:22Z", "shipFromId": "string", "shipFrom": { "id": "string", "street": "string", "city": "string", "state": "string", "stateCode": "string", "postalCode": "string", "country": "string", "countryCode": "string", "contactName": "string", "contactEmail": "string", "contactPhoneCode": "string", "contactPhone": "string", "additionalInformation": "string", "lat": 0.1, "lng": 0.1, "locationInfo": { "inputAddress": "string", "formattedAddress": "string", "lat": 0.1, "lng": 0.1, "type": "string" } }, "shipToId": "string", "shipTo": { "id": "string", "street": "string", "city": "string", "state": "string", "stateCode": "string", "postalCode": "string", "country": "string", "countryCode": "string", "contactName": "string", "contactEmail": "string", "contactPhoneCode": "string", "contactPhone": "string", "additionalInformation": "string", "lat": 0.1, "lng": 0.1, "locationInfo": { "inputAddress": "string", "formattedAddress": "string", "lat": 0.1, "lng": 0.1, "type": "string" } }, "courierId": "string", "archived": true, "cashOnDeliveryOrder": true, "stockProcessed": true, "isGift": true, "shippingLabel": { "comment": "string", "customerDocumentNumber": true, "organizationPhone": true, "organizationAddress": true, "observation": true, "orderNumber": true, "invoiceNumber": true, "orderValue": true, "shippingValue": true, "paymentStatus": true, "paymentMethod": true, "trackingNumber": true, "trackingQr": true, "contactSeller": true }, "statusLogs": [ { "statusId": "string", "date": "2019-08-24T14:15:22Z", "comments": [ { "key": "string", "comment": "string", "visibility": "string", "date": "2019-08-24T14:15:22Z" } ] } ], "statusId": "string", "status": { "id": "string", "accountId": "string", "aliasName": "string", "name": "string", "icon": "string", "active": true, "requiredNotification": true, "index": 0, "color": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "stockAction": "string" }, "outOfOrderCosts": true, "includesAccountsPayable": true, "shippingCost": 0.1, "costItems": [ { "name": "string", "value": 0.1 } ], "shippingMethod": "string", "totalWeight": 0.1, "isInsured": true, "insuranceValue": 0, "customDetails": { "property1": {}, "property2": {} }, "shippingTrackingLink": "string", "shippingTrackingNumber": "string" }, "message": "string"}Update stock POST
Add or remove stock for products and variants in the authenticated account. Send updates with warehouse_id, product_id, action (add/remove), origin and a positive quantity. All operations must use the same warehouse. For a variant, also send product_variant_id from the product's variants response; keep product_id as the owning product ID. Omitted or null product_variant_id uses the existing product-level operation. The response includes product_variant_id for each returned stock record. This operation is not idempotent; reconcile actual stock after an uncertain result before retrying. For origin purchase, supply both unit_cost (unit cost with taxes) and unit_cost_base (unit cost without taxes). Both must be finite and non-negative; zero is explicit, omission/null returns 400 for purchases. For other origins the pair is optional, but supplying one requires both. Products applies the existing last-purchase and weighted-average rules to the product or variant; cost is per unit, not the line total.
List taxes GET
Returns all taxes configured for the authenticated account. IDs belong to this account. Type is percentage or amount; value 19 with type percentage means 19%. is_include indicates an included tax. A zero value alone does not identify an excluded product. Listing does not assign taxes to products. No account parameter or pagination.