POST
Add a vendor pickup point
Company space For: Buyer, Manager · Permission: vendor_pickup_points.create Conditions
  • name is required, at most 255 characters, and unique among the supplier’s pickup points.
  • latitude must be between -90 and 90 and longitude between -180 and 180.
What else happens
  • The pickup point is active unless is_active is false.
Part of Manage suppliers.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

vendor
string
required

Identifier of the supplier the pickup point is created for.

Body

application/json
name
string
required

Name of the pickup point, up to 255 characters, unique among the supplier's pickup points. Required on creation.

Maximum string length: 255
address
string

Address of the pickup point, up to 1000 characters.

Maximum string length: 1000
latitude
number

Latitude in decimal degrees, from -90 to 90.

Required range: -90 <= x <= 90
longitude
number

Longitude in decimal degrees, from -180 to 180.

Required range: -180 <= x <= 180
is_active
boolean

Whether the pickup point can be used. Defaults to true on creation.

Response

VendorPickupPointResource

id
string
required

Identifier of the pickup point (27-character KSUID).

vendor_id
string
required

Identifier of the supplier the pickup point belongs to.

name
string
required

Name of the pickup point.

address
string | null
required

Address of the pickup point.

latitude
required

Latitude in decimal degrees, serialized with up to seven decimals.

longitude
required

Longitude in decimal degrees, serialized with up to seven decimals.

is_active
boolean
required

Whether the pickup point can be used.

created_at
string<date-time>
required

Date and time the record was created (ISO 8601, UTC).

updated_at
string<date-time>
required

Date and time the record was last changed (ISO 8601, UTC).