Boxy API
  1. Pick-ups
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
      • Create Bulk Orders (Sync)
      • Create Bulk Orders (Async)
      • List Orders
      • Show Order By UID
      • Show Order By Custom ID
      • Get Label Single
      • Get Label Bulk
      • Cancel Order
      • Update Order
      • Delete Order
    • Pick-ups
      • Request Pick-up
        POST
      • Request Pick-up Bulk
        POST
      • List Pick-ups
        GET
      • Show Pick-up
        GET
      • Get Pick-up Labels
        GET
      • Cancel Pick-up
        POST
      • Cancel Bulk Pick-ups
        POST
    • 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. Pick-ups

List Pick-ups

Production
https://api.tryboxy.com/api/v1/
Production
https://api.tryboxy.com/api/v1/
GET
merchants/pick-ups
List of Pick-ups

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/pick-ups' \
--header 'api-key: ' \
--header 'api-secret: '

Responses

🟢200Success
application/json
Body

Example
{
    "status": "success",
    "code": 200,
    "message": "Successfully done.",
    "object": {
        "items": [
            {
                "uid": "01JKDQA7YT9N18B000EMKMX68C",
                "platform_code": "BXPU-253673336",
                "date": "2025-02-07",
                "created_at": "2025-02-06T13:31:13+00:00",
                "updated_at": "2025-02-06T13:31:13+00:00",
                "deleted_at": null,
                "driver": null,
                "orders_count": 1,
                "status": {
                    "title": "new",
                    "slug": "new"
                },
                "pick_up_address": {
                    "uid": "01JKDQA7YT9N18B000EMKMX68C",
                    "platform_code": "BXPUA-253681248",
                    "title": "Main Warehouse",
                    "saved_pick_up_address_id": 100,
                    "type": "WAREHOUSE",
                    "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-02-06T13:31:13+00:00",
                    "updated_at": "2025-02-06T13:31:13+00:00",
                    "deleted_at": null
                }
            }
        ],
        "page": 1,
        "total": 3,
        "pages": 1,
        "perPage": 5
    }
}
Modified at 2025-02-06 13:35:14
Previous
Request Pick-up Bulk
Next
Show Pick-up
Built with