Assign vendor to address

Matches one of the account's delivery vendors (by its delivery service area) to the shipping address owned by the authenticated customer, then stores it as the address's vendor_id so future deliveries to that address route to that vendor. Returns the updated customer resource with a fresh JWT.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Assign a delivery vendor to a shipping address. Matches one of the account's delivery vendors (by its delivery service area) to the shipping address owned by the authenticated customer, then stores it as the address's vendor_id so future deliveries to that address route to that vendor. Returns the updated customer resource with a fresh JWT.

Example:

curl --request POST   --url 'https://www.pelcro.com/api/v1/sdk/address/101/assign-vendor?site_id=1232'   --header 'Authorization: Bearer <JWT>'   --header 'Accept: application/json'

Important Behaviors

  • Only shipping addresses are supported; a non-shipping address returns 400.
  • An address that isn't found or isn't owned by the customer returns 404.
  • Idempotent — if a vendor is already assigned, the call returns immediately.
  • Degrades gracefully: when the account isn't vendor-delivery-enabled or no vendor matches the address, the call still returns 200 with the address's vendor_id left null.
Path Params
int32
required

The unique identifier of the customer's shipping address.

Query Params
int32
required

The unique identifier of the site associated with your account.

Responses

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json