Create Pick-up Location

Production

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

POST

merchants/saved-pick-up-addresses

Create a pick-up location

Request

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 POST 'https://api.tryboxy.com/api/v1/merchants/saved-pick-up-addresses' \
--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": {
        "full_name": "John Doe",
        "phone": "9641111111111",
        "address_text": "Karada Street, Baghdad, Baghdad Governorate, Iraq",
        "type": "WAREHOUSE",
        "lng": "33.291227",
        "lat": "44.390452",
        "email": "info@example.com",
        "default": true,
        "description": "Main Warehouse",
        "title": "Main Warehouse",
        "platform_code": "BXSPUA-253585286",
        "uid": "01JKBDVCJPZ69RTC5ENGRXM6SN",
        "updated_at": "2025-02-05T16:07:20+00:00",
        "created_at": "2025-02-05T16:07:20+00:00"
    }
}

Modified at 2025-02-06 13:32:23

Cancel Bulk Pick-ups

List Pick-up Locations