Services

Services are provided by carriers and can be used to send shipments. Services are offered from a specific region to a specific region.

Attributes

API specification

Attribute Type Description Required
name string Service name (eg. Next Day), useful for displaying to users.
package_type string enum: parcel
letterbox
letter
unstamped
Type of package (eg. letter).
handover_method string enum: collection
drop-off
Available methods to hand the shipment to the carrier. Value collection means the carrier will pick up the shipment at the shipment’s sender address while drop-off means the sender has to drop the shipment at a pickup-dropoff-location.
delivery_method string enum: pick-up
delivery
Delivery method for the carrier. Services with value pick-up means the carrier delivers the shipment at a pickup-dropoff-location while delivery means they deliver at the shipment’s recipient address).
delivery_days array of string enum: Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday
Textual representation of days of the week this service delivers shipments.
transit_time transit time The minimum and maximum time it takes to deliver the shipment.
Relationship Type Description Required
carrier carriers Carrier offering the service.
region_from regions Region in which this service is available.
region_to regions Region where shipments can be delivered.

Endpoints

GET /services

GET /services/{service_id}

18-12-2018