Pickup Info

Storefront Pickup Info API endpoints

Endpoints

GET/pickup_info
POST/pickup_info
PATCH/pickup_info/{pickup_info_id}
DELETE/pickup_info/{pickup_info_id}

Get list of pickup infos

GET /pickup_info

An API endpoint to get list of pickup-info.

Query parameters

shipping_method_idoptionalinteger

Only return pickup infos usable with the given published local pickup shipping method.

ReturnsPickupInfo[]

Pickup-info object response

curl https://api.subbly.co/storefront/v1/pickup_info \
  -H 'X-API-KEY: <api-key>' \
  -H 'Authorization: Bearer <access-token>'

Response

[
  {
    "id": 3487,
    "first_name": "John",
    "last_name": "Smith",
    "phone": "+13232380656",
    "pickup_point": {
      "id": 12,
      "external_id": "FR-123456",
      "country_id": 74,
      "country_code": "FR",
      "country_name": "France",
      "type": "mondial_relay",
      "city": "Paris",
      "address_one": "1 Rue de Rivoli",
      "address_two": null,
      "zip": "75001"
    }
  }
]

Store pickup info

POST /pickup_info

An API endpoint to store pickup-info.

Request body

Store pickup info body

first_nameRequiredstring

last_nameRequiredstring

phoneoptionalstring | null

Required unless the shop has optional phone numbers enabled. Must be a valid international phone number.

pickup_point_idoptionalstring

External pickup point reference, formatted as a two letter country code and a numeric identifier, e.g. FR-123456. Required when pickup_point_type is sent.

pickup_point_typeoptionalstring

Required when pickup_point_id is sent.

Possible values: mondial_relay.

ReturnsPickupInfo

Pickup-info object response

curl -X POST https://api.subbly.co/storefront/v1/pickup_info \
  -H 'X-API-KEY: <api-key>' \
  -H 'Authorization: Bearer <access-token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "first_name": "first_name",
  "last_name": "last_name",
  "phone": "phone",
  "pickup_point_id": "pickup_point_id",
  "pickup_point_type": "mondial_relay"
}'

Response

{
  "id": 3487,
  "first_name": "John",
  "last_name": "Smith",
  "phone": "+13232380656",
  "pickup_point": {
    "id": 12,
    "external_id": "FR-123456",
    "country_id": 74,
    "country_code": "FR",
    "country_name": "France",
    "type": "mondial_relay",
    "city": "Paris",
    "address_one": "1 Rue de Rivoli",
    "address_two": null,
    "zip": "75001"
  }
}

Update pickup info

PATCH /pickup_info/{pickup_info_id}

An API endpoint to update the contact details of a customer pickup info. The linked pickup point cannot be changed.

Path parameters

pickup_info_idRequiredinteger

PickupInfo ID

Request body

Update pickup info body. Unlike an address, this payload is not merged - a phone left out is cleared when the shop makes phone numbers optional.

first_nameRequiredstring

last_nameRequiredstring

phoneoptionalstring | null

Required unless the shop has optional phone numbers enabled. Must be a valid international phone number.

ReturnsPickupInfo

Pickup-info object response

Error responses

400object

The pickup info does not belong to the customer.

401object

Missing or invalid customer token.

404object

The pickup info does not exist.

422object

Validation failed, for example a missing first_name/last_name or an invalid phone number.

curl -X PATCH https://api.subbly.co/storefront/v1/pickup_info/{pickup_info_id} \
  -H 'X-API-KEY: <api-key>' \
  -H 'Authorization: Bearer <access-token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "first_name": "first_name",
  "last_name": "last_name",
  "phone": "phone"
}'

Response

{
  "id": 3487,
  "first_name": "John",
  "last_name": "Smith",
  "phone": "+13232380656",
  "pickup_point": {
    "id": 12,
    "external_id": "FR-123456",
    "country_id": 74,
    "country_code": "FR",
    "country_name": "France",
    "type": "mondial_relay",
    "city": "Paris",
    "address_one": "1 Rue de Rivoli",
    "address_two": null,
    "zip": "75001"
  }
}

Delete pickup info

DELETE /pickup_info/{pickup_info_id}

An API endpoint to delete a customer pickup info.

Path parameters

pickup_info_idRequiredinteger

PickupInfo ID

Returns

No content

Error responses

400object

The pickup info does not belong to the customer.

401object

Missing or invalid customer token.

404object

The pickup info does not exist.

422any

The pickup info is in use: it is the shipping address of a subscription, or of an order awaiting delivery or a future shipment.

curl -X DELETE https://api.subbly.co/storefront/v1/pickup_info/{pickup_info_id} \
  -H 'X-API-KEY: <api-key>' \
  -H 'Authorization: Bearer <access-token>'

Pickup Info

Storefront Pickup Info API endpoints

Endpoints

GET/pickup_info
POST/pickup_info
PATCH/pickup_info/{pickup_info_id}
DELETE/pickup_info/{pickup_info_id}

Get list of pickup infos

GET /pickup_info

An API endpoint to get list of pickup-info.

Query parameters

shipping_method_idoptionalinteger

Only return pickup infos usable with the given published local pickup shipping method.

ReturnsPickupInfo[]

Pickup-info object response

idinteger

first_namestring

last_namestring

phonestring | null

pickup_pointPickupPoint | null

The pickup point the pickup info is attached to.

curl https://api.subbly.co/storefront/v1/pickup_info \
  -H 'X-API-KEY: <api-key>' \
  -H 'Authorization: Bearer <access-token>'

Response

[
  {
    "id": 3487,
    "first_name": "John",
    "last_name": "Smith",
    "phone": "+13232380656",
    "pickup_point": {
      "id": 12,
      "external_id": "FR-123456",
      "country_id": 74,
      "country_code": "FR",
      "country_name": "France",
      "type": "mondial_relay",
      "city": "Paris",
      "address_one": "1 Rue de Rivoli",
      "address_two": null,
      "zip": "75001"
    }
  }
]

Store pickup info

POST /pickup_info

An API endpoint to store pickup-info.

Request body

Store pickup info body

first_nameRequiredstring

last_nameRequiredstring

phoneoptionalstring | null

Required unless the shop has optional phone numbers enabled. Must be a valid international phone number.

pickup_point_idoptionalstring

External pickup point reference, formatted as a two letter country code and a numeric identifier, e.g. FR-123456. Required when pickup_point_type is sent.

pickup_point_typeoptionalstring

Required when pickup_point_id is sent.

Possible values: mondial_relay.

ReturnsPickupInfo

Pickup-info object response

idinteger

first_namestring

last_namestring

phonestring | null

pickup_pointPickupPoint | null

The pickup point the pickup info is attached to.

curl -X POST https://api.subbly.co/storefront/v1/pickup_info \
  -H 'X-API-KEY: <api-key>' \
  -H 'Authorization: Bearer <access-token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "first_name": "first_name",
  "last_name": "last_name",
  "phone": "phone",
  "pickup_point_id": "pickup_point_id",
  "pickup_point_type": "mondial_relay"
}'

Response

{
  "id": 3487,
  "first_name": "John",
  "last_name": "Smith",
  "phone": "+13232380656",
  "pickup_point": {
    "id": 12,
    "external_id": "FR-123456",
    "country_id": 74,
    "country_code": "FR",
    "country_name": "France",
    "type": "mondial_relay",
    "city": "Paris",
    "address_one": "1 Rue de Rivoli",
    "address_two": null,
    "zip": "75001"
  }
}

Update pickup info

PATCH /pickup_info/{pickup_info_id}

An API endpoint to update the contact details of a customer pickup info. The linked pickup point cannot be changed.

Path parameters

pickup_info_idRequiredinteger

PickupInfo ID

Request body

Update pickup info body. Unlike an address, this payload is not merged - a phone left out is cleared when the shop makes phone numbers optional.

first_nameRequiredstring

last_nameRequiredstring

phoneoptionalstring | null

Required unless the shop has optional phone numbers enabled. Must be a valid international phone number.

ReturnsPickupInfo

Pickup-info object response

idinteger

first_namestring

last_namestring

phonestring | null

pickup_pointPickupPoint | null

The pickup point the pickup info is attached to.

Error responses

400object

The pickup info does not belong to the customer.

401object

Missing or invalid customer token.

404object

The pickup info does not exist.

422object

Validation failed, for example a missing first_name/last_name or an invalid phone number.

curl -X PATCH https://api.subbly.co/storefront/v1/pickup_info/{pickup_info_id} \
  -H 'X-API-KEY: <api-key>' \
  -H 'Authorization: Bearer <access-token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "first_name": "first_name",
  "last_name": "last_name",
  "phone": "phone"
}'

Response

{
  "id": 3487,
  "first_name": "John",
  "last_name": "Smith",
  "phone": "+13232380656",
  "pickup_point": {
    "id": 12,
    "external_id": "FR-123456",
    "country_id": 74,
    "country_code": "FR",
    "country_name": "France",
    "type": "mondial_relay",
    "city": "Paris",
    "address_one": "1 Rue de Rivoli",
    "address_two": null,
    "zip": "75001"
  }
}

Delete pickup info

DELETE /pickup_info/{pickup_info_id}

An API endpoint to delete a customer pickup info.

Path parameters

pickup_info_idRequiredinteger

PickupInfo ID

Returns

No content

Error responses

400object

The pickup info does not belong to the customer.

401object

Missing or invalid customer token.

404object

The pickup info does not exist.

422any

The pickup info is in use: it is the shipping address of a subscription, or of an order awaiting delivery or a future shipment.

curl -X DELETE https://api.subbly.co/storefront/v1/pickup_info/{pickup_info_id} \
  -H 'X-API-KEY: <api-key>' \
  -H 'Authorization: Bearer <access-token>'