Show Order By Custom ID

Production

https://api.tryboxy.com/api/v1/

GET

merchants/orders/custom-id/{custom_id}

Show a single order by Custom ID (Order Reference)

Request

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.tryboxy.com/api/v1/merchants/orders/custom-id/' \
--header 'api-key: ' \
--header 'api-secret: '

Responses

🟢200Success

application/json

Body

Example

{
    "status": "success",
    "code": 200,
    "message": "Successfully done.",
    "object": {
        "uid": "01JKB212ANR00F4UIYD6Y8PB43",
        "platform_code": "BXO-253556395",
        "merchant_action_required": null,
        "merchant_action_required_text": null,
        "merchant_action_required_merchant_text": null,
        "pick_up_barcode": "253545137393928",
        "exception_comment": null,
        "is_fragile": 0,
        "custom_id": null,
        "fee": 30000,
        "fee_customer_payable": null,
        "pick_up_type": "PICK_UP",
        "payment_type": "COLLECT_ON_DELIVERY",
        "shipment_fee_type": "BY_MERCHANT",
        "size": "M",
        "full_name": "John Doe",
        "phone": "9641111111111",
        "additional_phones": null,
        "email": "johndoe@example.com",
        "address_text": "Baghdad, City Center",
        "lat": null,
        "lng": null,
        "description": "T-shirt and Mug from Acme Store",
        "created_at": "2025-02-05T12:40:44+00:00",
        "updated_at": "2025-02-05T12:40:44+00:00",
        "deleted_at": null,
        "preview": {
            "orders_value": 10000,
            "orders_shipment_fee": 30000,
            "orders_custom_shipment_fee": 0,
            "orders_value_with_platform_shipment_fee": 40000,
            "orders_value_with_shipment_fee": 40000
        },
        "driver": null,
        "tracking_page": "https://tracking.tryboxy.com/tracking/BXO-253556395",
        "tracking_auth_page": "https://bxy.bz/iRIaH",
        "region": {
            "uid": "01JBYGPFDV300Z603N7YVGK",
            "province_code": "BGD",
            "province_en_name": "baghdad",
            "province": "بغداد",
            "area_name": "الشعب",
            "area_name_slug": "BGD1",
            "remote": 0,
            "created_at": "2024-11-05T16:11:58+00:00",
            "updated_at": "2024-11-05T16:11:58+00:00",
            "deleted_at": null
        },
        "city": {
            "title": "Baghdad",
            "slug": "baghdad",
            "deleted_at": null
        },
        "statuses": [
            {
                "title": "new",
                "slug": "new",
                "merchant_title": "new",
                "pivot": {
                    "id": 9785,
                    "issuer_type": "MERCHANT",
                    "issuer_id": 2,
                    "carrier_message": null,
                    "created_at": "2025-02-05T12:40:44.000000Z",
                    "updated_at": "2025-02-05T12:40:44.000000Z"
                }
            }
        ],
        "status": {
            "title": "new",
            "slug": "new",
            "merchant_title": "new"
        },
        "last_statuses": [
            {
                "title": "new",
                "slug": "new",
                "created_at": "2025-02-05T12:40:44+00:00",
                "merchant_title": "new",
                "pivot": {
                    "id": 9785,
                    "issuer_type": "MERCHANT",
                    "issuer_id": 2,
                    "carrier_message": null,
                    "created_at": "2025-02-05T12:40:44.000000Z",
                    "updated_at": "2025-02-05T12:40:44.000000Z"
                }
            }
        ],
        "products": [
            {
                "uid": "01JKB212CRJH00WC4CJE4GG",
                "platform_code": "BXP-253554237",
                "title": "T-Shirt",
                "price": 10000,
                "currency": "IQD",
                "quantity": 1,
                "created_at": "2025-02-05T12:40:44+00:00",
                "updated_at": "2025-02-05T12:40:44+00:00",
                "deleted_at": null,
                "pivot": {
                    "created_at": "2025-02-05T12:40:44.000000Z",
                    "updated_at": "2025-02-05T12:40:44.000000Z"
                },
                "status": {
                    "title": "new",
                    "slug": "new"
                }
            }
        ],
        "saved_pick_up_address": {
            "uid": "01JJV7S71VS2RBSBB00QB0A",
            "platform_code": "BXSPUA-252922133",
            "title": "Main Warehouse",
            "type": "WAREHOUSE",
            "default": 1,
            "full_name": "John Doe",
            "phone": "9641111111111",
            "email": "info@example.com",
            "address_text": "Karada Street, Baghdad, Baghdad Governorate, Iraq",
            "lat": "44.390452",
            "lng": "33.291227",
            "description": "Main Warehouse",
            "created_at": "2025-01-30T09:13:27+00:00",
            "updated_at": "2025-01-30T09:13:27+00:00",
            "deleted_at": null
        },
        "pick_up": null
    }
}

Modified at 2025-02-05 13:25:15

Show Order By UID

Get Label Single