Get Pickup id

Developing

GET

https://api.gotreek.com/api/shipments/{shipmentReference}/pickup-id

Last modified:2026-07-17 17:47:11

Returns the Aramex pickup information associated with a shipment.

:::
Authentication

Requires Bearer token.
Only the owner of the shipment can access its pickup information.
The shipment must belong to the authenticated merchant.
:::

:::
Behavior

This endpoint is available only for Aramex shipments.
Retrieves the pickup information associated with the specified shipment reference.
Returns the shipment ID, shipment reference, Aramex pickup ID, and pickup GUID.
Indicates whether a pickup has already been scheduled through the has_pickup_id field.
If no pickup has been created yet, pickup_id and pickup_guid will be null, and has_pickup_id will be false.
:::

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

Path Params

Responses

🟢200

application/json

Bodyapplication/json

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.gotreek.com/api/shipments/50823520565/pickup-id' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "success": true,
    "data": {
        "shipment_id": 146039,
        "shipment_reference": "50823723834",
        "pickup_id": 1236,
        "pickup_guid": 12345,
        "has_pickup_id": false
    }
}

Modified at 2026-07-17 17:47:11

Print Invoice

Create Box