Update Order

Production

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

PATCH

merchants/orders/{order_uid}

Create s single order

Request

Path Params

Header Params

Body Params application/json

Example

{
    "is_fragile": false,
    "ready_to_pick_up": false,
    "fee_customer_payable": null,
    "shipment_fee_type": "BY_MERCHANT",
    "payment_type": "COLLECT_ON_DELIVERY",
    "pick_up_type": "PICK_UP",
    "description": "T-shirt and Mug from Acme Store",
    "custom_id": null, // Optional
    "products": [
        {
            "title": "T-Shirt",
            "price": 1500,
            "quantity": 1
        },
        {
            "title": "Mug",
            "price": 2000,
            "quantity": 2
        }
    ],
    "saved_pick_up_address_uid": "01JG1N4R1BCEN1V5NKRBP6YEY5", // Optional
    "size": "M", // Options: S, M, L
    "contact": { 
        "full_name": "John Doe",
        "address_text": "Baghdad, City Center",
        "phone": "9647835998521",
        "secondary_phone": null, // Optional
        "email": "johndoe@example.com",
        "region_name": "الشعب",
        "province_code": "BGD"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.tryboxy.com/api/v1/merchants/orders/' \
--header 'api-key: ' \
--header 'api-secret: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "is_fragile": false,
    "ready_to_pick_up": false,
    "fee_customer_payable": null,
    "shipment_fee_type": "BY_MERCHANT",
    "payment_type": "COLLECT_ON_DELIVERY",
    "pick_up_type": "PICK_UP",
    "description": "T-shirt and Mug from Acme Store",
    "custom_id": null, // Optional
    "products": [
        {
            "title": "T-Shirt",
            "price": 1500,
            "quantity": 1
        },
        {
            "title": "Mug",
            "price": 2000,
            "quantity": 2
        }
    ],
    "saved_pick_up_address_uid": "01JG1N4R1BCEN1V5NKRBP6YEY5", // Optional
    "size": "M", // Options: S, M, L
    "contact": { 
        "full_name": "John Doe",
        "address_text": "Baghdad, City Center",
        "phone": "9647835998521",
        "secondary_phone": null, // Optional
        "email": "johndoe@example.com",
        "region_name": "الشعب",
        "province_code": "BGD"
    }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "status": "success",
    "code": 200,
    "message": "Successfully done.",
    "object": {
        "order": {
            "pick_up_type": "PICK_UP",
            "platform_code": "BXO-253478507",
            "payment_type": "COLLECT_ON_DELIVERY",
            "shipment_fee_type": "BY_MERCHANT",
            "full_name": "John Doe",
            "address_text": "Baghdad, City Center",
            "phone": "9641111111111",
            "additional_phones": null,
            "description": "T-shirt and Mug from Acme Store",
            "custom_id": null,
            "email": "johndoe@example.com",
            "lat": null,
            "lng": null,
            "size": "M",
            "is_fragile": false,
            "fee": 30000,
            "fee_customer_payable": null,
            "uid": "01JK8FT6FM9MB9KA002WZDQYQY",
            "pick_up_barcode": "2534993949794616",
            "tracking_auth_code": "yfgAx",
            "updated_at": "2025-02-04T12:43:55+00:00",
            "created_at": "2025-02-04T12:43:55+00:00"
        },
        "preview": {
            "orders_value": 5500,
            "orders_shipment_fee": 30000,
            "orders_custom_shipment_fee": 0,
            "orders_value_with_platform_shipment_fee": 35500,
            "orders_value_with_shipment_fee": 35500
        }
    }
}

Modified at 2025-02-05 14:23:33

Cancel Order

Delete Order