Pickup Service Definition

A Pickup Service allows the sender to request that one or more packages be picked up at a specified time and location. Each pickup service that is offered must be defined in its own pickup service definition file. This file can reside anywhere within your application as long as its location is specified in the Carrier Application Definition file. The definition may be specified in JavaScript, TypeScript, JSON, or YAML.

These pickup service definitions will be used by the ShipEngine Connect to display pickup service options within our suite of e-commerce applications when your carrier is used.

Pickup Service Properties

Name	Type	Required?	Description
`id`	UUID	✔	UUID that uniquely identifies the pickup service. This ID should never change.
`identifiers`	object		Your own identifiers for this pickup service.
`code`	string		Optional code used to map to what the carrier or uses to identify the pickup service.
`name`	string	✔	The user-friendly service name (e.g. "One-Time Pickup", "Recurring Pickup", "Drop-Off").
`description`	string		A short, user-friendly description of the service.

Examples

import { PickupServiceConfig } from "@shipengine/connect";
const pickupService:PickupServiceConfig = {
  id: "27483200-72b4-11ea-bc55-0242ac130003",
  identifiers: {
        apiCode: "DO"
  }
  code: "DO",
  name: "Drop Off",
  description: "Drop-off your parcel at any Parcel Post™ kiosk or locker"
}

const pickupService = {
  id: "27483200-72b4-11ea-bc55-0242ac130003",
  identifiers: {
        apiCode: "DO"
  },
  code: "DO",
  name: "Drop Off",
  description: "Drop-off your parcel at any Parcel Post™ kiosk or locker"
}

{
  "id": "27483200-72b4-11ea-bc55-0242ac130003",
  "identifiers": {
        "apiCode": "DO"
  },
  "code": "DO",
  "name": "Drop Off",
  "description": "Drop-off your parcel at any Parcel Post™ kiosk or locker"
}

id: 27483200-72b4-11ea-bc55-0242ac130003
identifiers: {
  apiCode: DO
}
code: DO
name: Drop Off
description: Drop-off your parcel at any Parcel Post™ kiosk or locker