Skip to main content
GET
List pickup locations near a postal code (public)

Query Parameters

postal_code
string
required

Postal code to search around. When order_id is given and the order's zip code is known, that zip code is used instead.

Example:

"06600"

address
string

Street address, used by carriers that search by address

Example:

"Av. Insurgentes 100"

order_id
string

Encoded order identifier from the order's Cubbo tracking link. Enables eligibility filtering for that order.

Example:

"<encoded-order-id>"

Response

Pickup locations, optionally with the order's click-and-collect eligibility

rates
object[]
required

Pickup locations found

cnc_eligible
boolean

Present only when order_id was sent; whether that order can be converted to click and collect

Example:

true

code
enum<string>

Present only when cnc_eligible is false; why the order is not eligible, or CNC_INVALID_ORDER_ID when order_id could not be resolved

Available options:
CNC_INVALID_ORDER_ID,
CNC_INVALID_ORDER_STATUS,
CNC_MISSING_POSTAL_CODE,
CNC_ORIGINAL_NOT_CUBBO_BILLED,
CNC_ORIGINAL_NOT_NATIONAL_SHIPPING,
CNC_RATE_CARD_UNAVAILABLE
Example:

"CNC_INVALID_ORDER_STATUS"