Skip to main content

Submit Pickup (Local)

Schedule a pickup for a local order.

Endpoint​

POST /v1/pickup/submit

Request​

Header Parameters​

ParameterTypeRequiredExampleDescription
AuthorizationstringYesBearer YOUR_ACCESS_TOKENBearer token used for authentication.
Content-TypestringYesapplication/jsonRequest body content type.

Request Body Schema​

application/json
order_idrequired
string
Order ID for pickup request
Digits only (0–9).
Example: 3571000
pickup_daterequired
string
Requested pickup date.
Format: YYYY-MM-DD.
Example: 2026-02-26
pickup_time_startrequired
string
Start time of pickup window.
Format: HH:MM.
Example: 09:30
pickup_time_endrequired
string
End time of pickup window.
Format: HH:MM.
Note: Time difference between pickup_time_start and pickup_time_end must be exactly 150 minutes.
Example: 12:00

Example Request Body​

{
  "order_id": "3571000",
  "pickup_date": "2026-02-26",
  "pickup_time_start": "09:30",
  "pickup_time_end": "12:00"
}

Example request​

curl -X POST "${API_URL}/v1/pickup/submit" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "order_id": "3571000",
  "pickup_date": "2026-02-26",
  "pickup_time_start": "09:30",
  "pickup_time_end": "12:00"
}'

Responses​

200 Success​

200 Success

Response schema: application/json
data
object
Pickup submission result.
Expand for fields.
order_id
string
Order ID.
Example: 3571000
ship_type
string
Shipment type. Always local for local shipments.
tracking_number
string
Carrier tracking number (waybill).
Example: SF7444701709744
pickup_ref
string
Pickup reference.
pickup_date
string
Confirmed pickup date.
Example: 2026-02-26
order_status
string
Updated order status.
Example: PENDING_PICKUP
pickup_req_id
string
System-generated pickup request ID.
Example: 22424
message
string
Informational message.
Example: OK

Response sample

{
  "data": {
    "order_id": "3571000",
    "ship_type": "local",
    "tracking_number": "SF7444701709744",
    "pickup_ref": "SF7444701709744",
    "pickup_date": "2026-02-26",
    "order_status": "PENDING_PICKUP",
    "pickup_req_id": "22424",
    "message": "OK"
  }
}

400 Bad Request​

400 Bad Request

Response schema: application/json
code
string
Error code returned by the API.
Example: 400000
code_reason
string
Error reason.
Example: BAD_REQUEST
message
string
Human-readable message.
Example: Bad Request
error_trace
array
List of validation errors
field
string
Request field that failed.
message
string
Human-readable message.

Response sample

{
  "error": {
    "code": "400000",
    "code_reason": "BAD_REQUEST",
    "message": "Bad Request",
    "error_trace": [
      { "field": "pickup_date", "message": "pickup_date cannot be in the past" }
    ]
  }
}

401 Unauthorized​

401 Unauthorized

Response schema: application/json
code
string
Error code.
Example: 401000
code_reason
string
Error reason.
Example: UNAUTHORIZED
message
string
Human-readable message.
Example: Unauthorized

Response sample

{
  "error": {
    "code": "401000",
    "code_reason": "UNAUTHORIZED",
    "message": "Unauthorized"
  }
}

403 Forbidden​

403 Forbidden

Response schema: application/json
error
json-string
Access forbidden for this resource.

404 Not Found​

404 Not Found

Response schema: application/json
error
json-string
Resource or endpoint not found.

500 Failure​

500 Failure

Response schema: application/json
code
string
Error code returned by the API.
Example: 500999
code_reason
string
Machine-readable error reason.
Example: API_ERROR
message
string
Human-readable message.
Example: Api Error, please contact customer service

Response sample

{
  "error": {
    "code": "500999",
    "code_reason": "API_ERROR",
    "message": "Api Error, please contact customer service"
  }
}