Private API reference

Pickup Info

Private 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 info

GET /pickup_info

List a customer's local pickup contacts. Without shipping_method_id, and for a pickup-point shipping method, only entries with no linked pickup point are returned. For a custom local pickup method, only entries whose pickup point is in that method's country are returned. The response is not paginated.

Query parameters

customer_idRequiredinteger

ID of a customer of your shop whose pickup info is listed.

shipping_method_idoptionalinteger | null

A published local pickup shipping method of your shop, used to narrow the list.

Returnsobject

Pickup info list response

Error responses

422object

customer_id is not a customer of your shop, or shipping_method_id is not a published local pickup method of your shop.

curl https://api.subbly.co/private/v1/pickup_info \
  -H 'X-API-KEY: <api-key>'

Response

{
  "data": [
    {
      "id": 3487,
      "pickup_point": {
        "id": 45,
        "external_id": "FR-012345",
        "country_id": 74,
        "country_code": "FR",
        "country_name": "France",
        "type": "mondial_relay",
        "city": "Paris",
        "address_one": "address_one",
        "address_two": "address_two",
        "zip": "75001"
      },
      "phone": "+13232380656",
      "first_name": "John",
      "last_name": "Smith"
    }
  ]
}

Create pickup info

POST /pickup_info

Add a local pickup contact to a customer of your shop. Sending pickup_point_id together with pickup_point_type links an external pickup point, which is looked up at the provider and must sit in a country covered by one of the shop's published local pickup methods. Omit both to store a plain pickup contact.

Request body

customer_idRequiredinteger

ID of the customer the pickup info belongs to.

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, prefixed with the ISO country code. Required as soon as pickup_point_type is sent. The country must be covered by one of the shop's published local pickup methods and the point must exist at the provider.

pickup_point_typeoptionalstring

Required as soon as pickup_point_id is sent.

Possible values: mondial_relay.

ReturnsPickupInfo

Pickup info object response

Error responses

422object

Validation failed, for example a customer_id that is not a customer of your shop, a missing name, an invalid phone number, a pickup_point_id that does not match the CC-123456 format or is unknown at the provider, or only one of pickup_point_id/pickup_point_type being sent.

curl -X POST https://api.subbly.co/private/v1/pickup_info \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "customer_id": 1,
  "first_name": "John",
  "last_name": "Smith",
  "phone": "+13232380656",
  "pickup_point_id": "FR-012345",
  "pickup_point_type": "mondial_relay"
}'

Response

{
  "id": 3487,
  "pickup_point": {
    "id": 45,
    "external_id": "FR-012345",
    "country_id": 74,
    "country_code": "FR",
    "country_name": "France",
    "type": "mondial_relay",
    "city": "Paris",
    "address_one": "address_one",
    "address_two": "address_two",
    "zip": "75001"
  },
  "phone": "+13232380656",
  "first_name": "John",
  "last_name": "Smith"
}

Update pickup info

PATCH /pickup_info/{pickup_info_id}

Update the contact details of a local pickup entry. Only the name and phone number can be changed; the linked pickup point is fixed at creation time. Unlike an address, this payload is not merged - a phone left out is cleared when the shop makes phone numbers optional. The entry must belong to a customer of your shop.

Path parameters

pickup_info_idRequiredinteger

Pickup info ID

Format: integer.

Request body

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

404object

The pickup info does not exist or does not belong to a customer of your shop.

422object

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

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

Response

{
  "id": 3487,
  "pickup_point": {
    "id": 45,
    "external_id": "FR-012345",
    "country_id": 74,
    "country_code": "FR",
    "country_name": "France",
    "type": "mondial_relay",
    "city": "Paris",
    "address_one": "address_one",
    "address_two": "address_two",
    "zip": "75001"
  },
  "phone": "+13232380656",
  "first_name": "John",
  "last_name": "Smith"
}

Delete pickup info

DELETE /pickup_info/{pickup_info_id}

Delete a local pickup entry. An entry that is still linked to a subscription, or to an order awaiting delivery or a future shipment, cannot be deleted.

Path parameters

pickup_info_idRequiredinteger

Pickup info ID

Format: integer.

ReturnsPickupInfo

The deleted pickup info

Error responses

404object

The pickup info does not exist or does not belong to a customer of your shop.

422object

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/private/v1/pickup_info/{pickup_info_id} \
  -H 'X-API-KEY: <api-key>'

Response

{
  "id": 3487,
  "pickup_point": {
    "id": 45,
    "external_id": "FR-012345",
    "country_id": 74,
    "country_code": "FR",
    "country_name": "France",
    "type": "mondial_relay",
    "city": "Paris",
    "address_one": "address_one",
    "address_two": "address_two",
    "zip": "75001"
  },
  "phone": "+13232380656",
  "first_name": "John",
  "last_name": "Smith"
}