Pick-up info

Read, create, and delete the pick-up contact records of the customer.

subbly.pickupInfo.list(params)

Gets the pick-up contact records the signed-in customer saved. A record says who collects the parcel, and which point they collect it from. Needs an authenticated customer.

Method parameters

paramsRequiredPickupInfoFetchParams

Which records to return. The argument is required by position, so pass an empty object for all of them.

shippingMethodIdoptionalnumber

Keep only the records that work with this pick-up shipping method. In practice this filters by country.

ReturnsPromise<CustomerPickupInfo[]>

The saved records.


List every record
const pickupInfos = await subbly.pickupInfo.list({})


List the records for one pick-up method
const [method] = await subbly.cart.getLocalPickups()
const pickupInfos = await subbly.pickupInfo.list({ shippingMethodId: method.id })

subbly.pickupInfo.store(payload)

Creates a pick-up contact record for the signed-in customer. Put its id on the cart as shippingAddressId once the customer chose a pick-up point. Needs an authenticated customer.

Method parameters

payloadRequiredPickupInfoStorePayload

The record to create.

ReturnsPromise<CustomerPickupInfo>

The record created.


Add a record
const pickupInfo = await subbly.pickupInfo.store({
  firstName: 'Ada',
  lastName: 'Lovelace',
  phone: '+15551234567'
})

await subbly.cart.update({ shippingAddressId: pickupInfo.id })


Add a record for a Mondial Relay point
await subbly.pickupInfo.store({
  firstName: 'Ada',
  lastName: 'Lovelace',
  phone: '+33123456789',
  pickupPointType: 'mondial_relay',
  pickupPointId: '005670'
})

subbly.pickupInfo.delete(pickupInfoId)

Deletes a pick-up contact record. Needs an authenticated customer. The request fails while a subscription still uses the record.

Method parameters

pickupInfoIdRequirednumber

ID of the record to delete.

ReturnsPromise<void>

Nothing. The response body is empty.


Delete a record
await subbly.pickupInfo.delete(123)

Last modified on September 15, 2026

Pick-up info

Read, create, and delete the pick-up contact records of the customer.

subbly.pickupInfo.list(params)

Gets the pick-up contact records the signed-in customer saved. A record says who collects the parcel, and which point they collect it from. Needs an authenticated customer.

Method parameters

paramsRequiredPickupInfoFetchParams

Which records to return. The argument is required by position, so pass an empty object for all of them.

shippingMethodIdoptionalnumber

Keep only the records that work with this pick-up shipping method. In practice this filters by country.

ReturnsPromise<CustomerPickupInfo[]>

The saved records.


List every record
const pickupInfos = await subbly.pickupInfo.list({})


List the records for one pick-up method
const [method] = await subbly.cart.getLocalPickups()
const pickupInfos = await subbly.pickupInfo.list({ shippingMethodId: method.id })

subbly.pickupInfo.store(payload)

Creates a pick-up contact record for the signed-in customer. Put its id on the cart as shippingAddressId once the customer chose a pick-up point. Needs an authenticated customer.

Method parameters

payloadRequiredPickupInfoStorePayload

The record to create.

firstNameRequiredstring

Given name of the person who collects the parcel.

lastNameRequiredstring

Family name of that person.

phoneRequiredstring

Phone number of that person.

pickupPointTypeoptional'mondial_relay'

Set this only for a point in an external network. mondial_relay is the one value the field takes.

pickupPointIdoptionalstring

ID of the point in that external network.

ReturnsPromise<CustomerPickupInfo>

The record created.


Add a record
const pickupInfo = await subbly.pickupInfo.store({
  firstName: 'Ada',
  lastName: 'Lovelace',
  phone: '+15551234567'
})

await subbly.cart.update({ shippingAddressId: pickupInfo.id })


Add a record for a Mondial Relay point
await subbly.pickupInfo.store({
  firstName: 'Ada',
  lastName: 'Lovelace',
  phone: '+33123456789',
  pickupPointType: 'mondial_relay',
  pickupPointId: '005670'
})

subbly.pickupInfo.delete(pickupInfoId)

Deletes a pick-up contact record. Needs an authenticated customer. The request fails while a subscription still uses the record.

Method parameters

pickupInfoIdRequirednumber

ID of the record to delete.

ReturnsPromise<void>

Nothing. The response body is empty.


Delete a record
await subbly.pickupInfo.delete(123)

Last modified on September 15, 2026