Boxy API
  1. Orders
Boxy API
  • Getting Started
    • Introduction
    • Environments
    • Security & Authentication
    • Rate Limit
    • Postman Collections
    • Schemas
    • Webhooks
  • Guides
    • Order Flow (Statuses)
    • Provinces & Regions
  • API Reference
    • Merchant
      • Get Merchant Info
    • Orders
      • Create Order
        POST
      • Create Bulk Orders (Sync)
        POST
      • Create Bulk Orders (Async)
        POST
      • List Orders
        GET
      • Show Order By UID
        GET
      • Show Order By Custom ID
        GET
      • Get Label Single
        GET
      • Get Label Bulk
        GET
      • Cancel Order
        POST
      • Update Order
        PATCH
      • Delete Order
        DELETE
    • Pick-ups
      • Request Pick-up
      • Request Pick-up Bulk
      • List Pick-ups
      • Show Pick-up
      • Get Pick-up Labels
      • Cancel Pick-up
      • Cancel Bulk Pick-ups
    • Pick-up Locations
      • Create Pick-up Location
      • List Pick-up Locations
      • Show Pick-up Location
      • Show Cash Drop-off Location
      • Update Pick-up Location
      • Delete Pick-up Location
    • Regions
      • List Regions
  1. Orders

Create Bulk Orders (Sync)

Production
https://api.tryboxy.com/api/v1/
Production
https://api.tryboxy.com/api/v1/
POST
merchants/orders/bulk-request-sync
Create multiple orders at a time, this endpoint is synchronous and you can create up to 1000 orders at a time.

Request

Header Params

Body Params application/json

Example
{
    "ready_to_pick_up": false,
    "orders": [
        {
            "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,
            "products": [
                {
                    "title": "T-Shirt",
                    "price": 1500,
                    "quantity": 1
                },
                {
                    "title": "Mug",
                    "price": 2000,
                    "quantity": 2
                }
            ],
            "saved_pick_up_address_uid": "01JG1N4R1BCEN1V5NKRBP6YEY5",
            "size": "M",
            "contact": { 
                "full_name": "John Doe",
                "address_text": "Baghdad, City Center",
                "phone": "9641111111111",
                "secondary_phone": null, 
                "email": "johndoe@example.com",
                "region_name": "الشعب",
                "province_code": "BGD"
            }
        }, 

        {
            "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, 
            "products": [
                {
                    "title": "T-Shirt",
                    "price": 1500,
                    "quantity": 1
                },
                {
                    "title": "Mug",
                    "price": 2000,
                    "quantity": 2
                }
            ],
            "saved_pick_up_address_uid": "01JG1N4R1BCEN1V5NKRBP6YEY5", 
            "size": "M", 
            "contact": { 
                "full_name": "John Doe",
                "address_text": "Baghdad, City Center",
                "phone": "9641111111111",
                "secondary_phone": null, 
                "email": "johndoe@example.com",
                "region_name": "الشعب",
                "province_code": "BGD"
            }
        }

    ]
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.tryboxy.com/api/v1/merchants/orders/bulk-request-sync' \
--header 'api-key: ' \
--header 'api-secret: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ready_to_pick_up": false,
    "orders": [
        {
            "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,
            "products": [
                {
                    "title": "T-Shirt",
                    "price": 1500,
                    "quantity": 1
                },
                {
                    "title": "Mug",
                    "price": 2000,
                    "quantity": 2
                }
            ],
            "saved_pick_up_address_uid": "01JG1N4R1BCEN1V5NKRBP6YEY5",
            "size": "M",
            "contact": { 
                "full_name": "John Doe",
                "address_text": "Baghdad, City Center",
                "phone": "9641111111111",
                "secondary_phone": null, 
                "email": "johndoe@example.com",
                "region_name": "الشعب",
                "province_code": "BGD"
            }
        }, 

        {
            "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, 
            "products": [
                {
                    "title": "T-Shirt",
                    "price": 1500,
                    "quantity": 1
                },
                {
                    "title": "Mug",
                    "price": 2000,
                    "quantity": 2
                }
            ],
            "saved_pick_up_address_uid": "01JG1N4R1BCEN1V5NKRBP6YEY5", 
            "size": "M", 
            "contact": { 
                "full_name": "John Doe",
                "address_text": "Baghdad, City Center",
                "phone": "9641111111111",
                "secondary_phone": null, 
                "email": "johndoe@example.com",
                "region_name": "الشعب",
                "province_code": "BGD"
            }
        }

    ]
}'

Responses

🟢200Success
application/json
Body

Example
{
    "status": "success",
    "code": 200,
    "message": "Successfully done.",
    "object": null
}
Modified at 2025-03-06 11:54:22
Previous
Create Order
Next
Create Bulk Orders (Async)
Built with