- Getting Started
- Guides
- API Reference
- Merchant
- Orders
- Pick-ups
- Pick-up Locations
- Regions
List Orders
Production
https://api.tryboxy.com/api/v1/
Production
https://api.tryboxy.com/api/v1/
GET
merchants/orders
Request
Header Params
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 GET 'https://api.tryboxy.com/api/v1/merchants/orders' \
--header 'api-key: ' \
--header 'api-secret: 'Responses
🟢200Success
application/json
Body
Example
{
"status": "success",
"code": 200,
"message": "Successfully done.",
"object": {
"items": [
{
"uid": "01JKB212ANR00F400YD6Y8PB43",
"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,
"products_value": 10000,
"carrier_message": null,
"status": {
"title": "new",
"slug": "new",
"merchant_title": "new"
},
"products": [
{
"uid": "01JKB212CRJHMRW00VC4CJE4GG",
"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"
}
}
],
"saved_pick_up_address": {
"uid": "01JJV7S71VS2RB00WSBB91QB0A",
"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
},
{
"uid": "01JKB2122XA29W9J00AAVP0VFP",
"platform_code": "BXO-253594721",
"merchant_action_required": null,
"merchant_action_required_text": null,
"merchant_action_required_merchant_text": null,
"pick_up_barcode": "2535269196192787",
"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:43+00:00",
"updated_at": "2025-02-05T12:40:43+00:00",
"deleted_at": null,
"products_value": 5500,
"carrier_message": null,
"status": {
"title": "new",
"slug": "new",
"merchant_title": "new"
},
"products": [
{
"uid": "01JKB21251NX500DR342B8A7AA",
"platform_code": "BXP-253523420",
"title": "T-Shirt",
"price": 1500,
"currency": "IQD",
"quantity": 1,
"created_at": "2025-02-05T12:40:43+00:00",
"updated_at": "2025-02-05T12:40:43+00:00",
"deleted_at": null,
"pivot": {
"created_at": "2025-02-05T12:40:43.000000Z",
"updated_at": "2025-02-05T12:40:43.000000Z"
}
},
{
"uid": "01JKB2127JWGAQNZ00ZFHD3P0Z",
"platform_code": "BXP-253538638",
"title": "Mug",
"price": 2000,
"currency": "IQD",
"quantity": 2,
"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"
}
}
],
"saved_pick_up_address": {
"uid": "01JJV7S71VS2R00YWSBB91QB0A",
"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
},
{
"uid": "01JKB1MM9B3G800EJ4DZ35KJB2",
"platform_code": "BXO-253576390",
"merchant_action_required": null,
"merchant_action_required_text": null,
"merchant_action_required_merchant_text": null,
"pick_up_barcode": "2535679277017073",
"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:33:56+00:00",
"updated_at": "2025-02-05T12:33:56+00:00",
"deleted_at": null,
"products_value": 10000,
"carrier_message": null,
"status": {
"title": "new",
"slug": "new",
"merchant_title": "new"
},
"products": [
{
"uid": "01JKB1MMFRF00YQ1K0GQFQ65MT",
"platform_code": "BXP-253535820",
"title": "T-Shirt",
"price": 10000,
"currency": "IQD",
"quantity": 1,
"created_at": "2025-02-05T12:33:56+00:00",
"updated_at": "2025-02-05T12:33:56+00:00",
"deleted_at": null,
"pivot": {
"created_at": "2025-02-05T12:33:56.000000Z",
"updated_at": "2025-02-05T12:33:56.000000Z"
}
}
],
"saved_pick_up_address": {
"uid": "01JJV7S71VS200ZYWSBB91QB0A",
"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
},
{
"uid": "01JKB1MKXKN00ZJ75RZK9XNV5J",
"platform_code": "BXO-253599717",
"merchant_action_required": null,
"merchant_action_required_text": null,
"merchant_action_required_merchant_text": null,
"pick_up_barcode": "2535624199965300",
"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:33:56+00:00",
"updated_at": "2025-02-05T12:33:56+00:00",
"deleted_at": null,
"products_value": 5500,
"carrier_message": null,
"status": {
"title": "new",
"slug": "new",
"merchant_title": "new"
},
"products": [
{
"uid": "01JKB1MM1AC00SV929KPGQ5AS2",
"platform_code": "BXP-253528979",
"title": "T-Shirt",
"price": 1500,
"currency": "IQD",
"quantity": 1,
"created_at": "2025-02-05T12:33:56+00:00",
"updated_at": "2025-02-05T12:33:56+00:00",
"deleted_at": null,
"pivot": {
"created_at": "2025-02-05T12:33:56.000000Z",
"updated_at": "2025-02-05T12:33:56.000000Z"
}
},
{
"uid": "01JKB1M00333NZE4E717XGXYFJ",
"platform_code": "BXP-253516444",
"title": "Mug",
"price": 2000,
"currency": "IQD",
"quantity": 2,
"created_at": "2025-02-05T12:33:56+00:00",
"updated_at": "2025-02-05T12:33:56+00:00",
"deleted_at": null,
"pivot": {
"created_at": "2025-02-05T12:33:56.000000Z",
"updated_at": "2025-02-05T12:33:56.000000Z"
}
}
],
"saved_pick_up_address": {
"uid": "01JJV7S71VS2RB00WSBB91QB0A",
"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
},
{
"uid": "9641111111111",
"platform_code": "BXO-253585187",
"merchant_action_required": null,
"merchant_action_required_text": null,
"merchant_action_required_merchant_text": null,
"pick_up_barcode": "2535836444164584",
"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:28:31+00:00",
"updated_at": "2025-02-05T12:28:31+00:00",
"deleted_at": null,
"products_value": 5500,
"carrier_message": null,
"status": {
"title": "new",
"slug": "new",
"merchant_title": "new"
},
"products": [
{
"uid": "01JKB1APX30ETXNH00GPB9EPXA",
"platform_code": "BXP-253586395",
"title": "T-Shirt",
"price": 1500,
"currency": "IQD",
"quantity": 1,
"created_at": "2025-02-05T12:28:31+00:00",
"updated_at": "2025-02-05T12:28:31+00:00",
"deleted_at": null,
"pivot": {
"created_at": "2025-02-05T12:28:31.000000Z",
"updated_at": "2025-02-05T12:28:31.000000Z"
}
},
{
"uid": "01JKB1AQ3991PT00NPVRZ1HJSF",
"platform_code": "BXP-253588281",
"title": "Mug",
"price": 2000,
"currency": "IQD",
"quantity": 2,
"created_at": "2025-02-05T12:28:31+00:00",
"updated_at": "2025-02-05T12:28:31+00:00",
"deleted_at": null,
"pivot": {
"created_at": "2025-02-05T12:28:31.000000Z",
"updated_at": "2025-02-05T12:28:31.000000Z"
}
}
],
"saved_pick_up_address": {
"uid": "01JJV7S71VS2RBZYWS0091QB0A",
"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
}
],
"page": 1,
"total": 23,
"pages": 5,
"perPage": 5
}
}Modified at 2025-02-05 16:08:46