The pickup object

A comprehensive list of the pickup resource's attributes and relationships

A pickup object is returned as part of the response body of each successful list or retrieve API call to the /api/pickups endpoint.

Fields

Field
Type
Description

type

string

pickups

id

string

The pickup unique identifier

links.self

string

The pickup endpoint URL

attributes.status

string

The pick up status.

attributes.internal_id

string

The pick up service internal ID.

attributes.created_at

datetime

Time at which the resource was created.

attributes.updated_at

datetime

Time at which the resource was last updated.

attributes.reference

string

A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.

attributes.reference_origin

string

Any identifier of the third party system that defines the reference code.

attributes.metadata

object

Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.

relationships.shipment

object

The associated shipment.

relationships.parcels

array

The associated parcels.

relationships.events

array

The associated events.

relationships.event_stores

array

The associated event stores.

meta.mode

string

The resource environment (can be one of test or live)

Last updated