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

Request Pick-up

Production
https://api.tryboxy.com/api/v1/
Production
https://api.tryboxy.com/api/v1/
POST
merchants/pick-ups/request
Request orders to be pick-up

Request

Header Params

Body Params application/json

Example
{
    "order_uids": [
        "01JEK3NXZNKH00TPVZ00C91DJF",
        "01JEK3NRN4B7NZQFVBMQB00XSQ",
        "01JEK3NG3YM100EC0A2JA8PY3B",
        "01JEK3N8GTR100RV370XD6BZYN",
        "01JEK3N18NHQVB8A2W6Q00H5YY"
    ]
}

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/pick-ups/request' \
--header 'api-key: ' \
--header 'api-secret: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "order_uids": [
        "01JEK3NXZNKH00TPVZ00C91DJF",
        "01JEK3NRN4B7NZQFVBMQB00XSQ",
        "01JEK3NG3YM100EC0A2JA8PY3B",
        "01JEK3N8GTR100RV370XD6BZYN",
        "01JEK3N18NHQVB8A2W6Q00H5YY"
    ]
}'

Responses

🟢200Success
application/json
Body

Example
{
    "status": "success",
    "code": 200,
    "message": "Successfully done.",
    "object": [
        {
            "date": "2025-02-07",
            "platform_code": "BXPU-253673336",
            "uid": "01JKDQA7YT9N1800M0EM00X68C",
            "updated_at": "2025-02-06T13:31:13+00:00",
            "created_at": "2025-02-06T13:31:13+00:00"
        }
    ]
}
Modified at 2025-02-06 13:40:06
Previous
Delete Order
Next
Request Pick-up Bulk
Built with