Get Statuses

Developing

GET

https://app.gotreek.com/api/orders/statuses

Last modified:2025-12-25 15:09:11

Retrieve the list of all available order status codes and their human‑readable labels. This endpoint is typically used by clients to populate dropdowns and validate allowed status values.

📌

Authentication

Requires Bearer token.

💡

Behavior

Returns a static or configuration‑driven list of status codes and labels.

Can be used to validate allowed values for order status fields on create or update operations.

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

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://app.gotreek.com/api/orders/statuses' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "data": {
        "values": [
            "pending",
            "awaiting_pickup",
            "currently_shipping",
            "delivered",
            "returned",
            "refused",
            "shipment_on_hold",
            "canceled",
            "failed",
            "not_changed"
        ],
        "options": [
            {
                "value": "pending",
                "label": "Pending"
            },
            {
                "value": "awaiting_pickup",
                "label": "Awaiting pickup"
            },
            {
                "value": "currently_shipping",
                "label": "Currently shipping"
            },
            {
                "value": "delivered",
                "label": "Delivered"
            },
            {
                "value": "returned",
                "label": "Returned"
            },
            {
                "value": "refused",
                "label": "Refused"
            },
            {
                "value": "shipment_on_hold",
                "label": "Shipment on hold"
            },
            {
                "value": "canceled",
                "label": "Canceled"
            },
            {
                "value": "failed",
                "label": "Failed"
            },
            {
                "value": "not_changed",
                "label": "Not changed"
            }
        ]
    }
}

Modified at 2025-12-25 15:09:11

Reset Order

Verify Item