POST/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/carts/{cartId}/pickup_points

List pickup points for a delivery option Experimental

Pickup points near the address for a carrier product that needs one, nearest first. Send the chosen point's number and name as carrierProductPayload.partnerNumber and partnerName in the checkout's freight block.

Parameters

tenantIdpathstringnon-nullrequired
eComStoreIdpathstringnon-nullrequired
cartIdpathstringnon-nullrequired

Request body (required)

application/jsonobjectnon-null

addressobjectnon-nullrequired

Show child fields

citystringnon-nullrequired
countryIsoCodestringnon-nullrequired: ISO 3166-1 alpha-2
Example"NO"
postCodestringnon-nullrequired
streetstringnullableoptional: Street address; improves pickup point ordering

carrierCodestringnon-nullrequired

carrierProductCodestringnon-nullrequired

View schema definition

Responses

200Response

application/jsonobjectnon-null

pickupPointsarray of objectnon-nullrequired

Show item fields

A place the shopper can collect the parcel; number and name go on the order as carrierProductPayload

citystringnullableoptional
countryIsoCodestringnon-nullrequired
distanceKmnumbernullableoptional: Format: double
namestringnon-nullrequired
numberstringnon-nullrequired
postCodestringnullableoptional
streetstringnullableoptional
typestringnullableoptional: manned or locker when the carrier says

View schema definition

400Response

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

401Response

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

403Response

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

404Response

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

409Response

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

422Response

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition