Create Shipment

Creates a shipment for an existing order using the specified courier service ,debit the appropriate wallet if needed, and generate a printable shipping label.

📌

Authentication

Requires Bearer token.

Only orders belonging to the authenticated merchant can be used to create a shipment.

📌

Behavior

The phone number must be valid and correctly formatted for the shipment to be created successfully.

Creates a shipment for the specified order using the selected courier and either global or order‑level configuration.

Calculates shipment cost, optionally debits the merchant or warehouse user wallet, and records a wallet transaction.

Generates a shipping label PDF and updates the order’s latest shipment fields (tracking link, label URL, costs, external id, status)

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://app.gotreek.com/api/auth/login

Header Params

Body Params application/jsonRequired

Examples

curl --location --request POST 'https://app.gotreek.com/api/shipments' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "order_id": 123, "courier": "aramex" }'

{ "success": true, "message": "Shipment created successfully", "data": { "shipment_id": 23153, "tracking_link": "http://localhost/shipment_tracking?trackingNumber=100387034046", "shipment_label_url": "https://elasticbeanstalk-eu-central-1-640066223797.s3-accelerate.amazonaws.com/360/Deliverist_1766159050543_report.pdf", "shipment_cost": 2595, "shipment_cost_without_cod": 1795, "order_status": "awaiting_pickup", "courier": "deliverist", "external_id": "38703404" } }

Request

Responses