Download OpenAPI specification:Download
Swyft is a last-mile delivery service that offers same and next-day shipping to customers at affordable rates. The Swyft technology platform with its network of warehouses and delivery companies provides merchants and their customers the best delivery experience possible.
Welcome to the API documentation!
To use our API, make sure to set up your Swyft account by contacting your Merchant Success Manager or by contacting Swyft Support. Most user actions that can be done in our Merchant Dashboard can be done though our REST API.
Label API endpoints provide a way to create, delete, fetch and print labels in Swyft's system.
Package size matrix:
Swyft Size Code | Max Vol (cuft) | Max Weight (lbs) | Max Length on any side (in) |
---|---|---|---|
Small | 0.5 | 5 | 26 |
Medium | 1 | 10 | 26 |
Large | 2 | 20 | 26 |
Extra Large | 3.3 | 35 | 26 |
Create a bulk number of labels with a single request. Accepts a maximum of 100 labels per request. Each label will be validated against the label schema, if any do not validate then the request will fail returning the index of the invalid label from the array. If the schema is successful, the labels will be generated and returned as an array of labels, if any of these labels failed to be created due to issues such as address validation, then that row in the returned array will be an error object instead.
Array of objects (CreateLabelsWithPackageType) |
{- "labels": [
- {
- "package_type": "SMALL",
- "service_type": "SAMEDAY",
- "business_name": "Acme Corporation",
- "origin": {
- "first_name": "Bob",
- "last_name": "Dylan",
- "phone": "416 647 8888",
- "address": {
- "line1": "222 Bay St",
- "city": "Toronto",
- "postal_code": "M5J 2W4",
- "province": "ON",
- "country": "CA"
}
}, - "destination": {
- "first_name": "Elton",
- "last_name": "John",
- "phone": "647 416 8888",
- "address": {
- "line1": "188 University Ave",
- "line2": "Unit 4303",
- "city": "Toronto",
- "postal_code": "M5T 1A1",
- "province": "ON",
- "country": "CA"
}
}, - "notes": "Ask concierge for elevator access",
- "order_number": "12345ABC",
- "shipment_id": "567890ABC",
- "reference": "order #9000",
- "reference2": "order #9000"
}
]
}
[- {
- "id": "bqofiflh5s5id0diioug",
- "package_type": "SMALL",
- "service_type": "SAMEDAY",
- "business_name": "Acme Corporation",
- "origin": {
- "first_name": "Bob",
- "last_name": "Dylan",
- "phone": "416 647 8888",
- "address": {
- "line1": "222 Bay St",
- "city": "Toronto",
- "postal_code": "M5J 2W4",
- "province": "ON",
- "country": "CA"
}
}, - "destination": {
- "first_name": "Elton",
- "last_name": "John",
- "phone": "647 416 8888",
- "address": {
- "line1": "188 University Ave",
- "line2": "Unit 4303",
- "city": "Toronto",
- "postal_code": "M5T 1A1",
- "province": "ON",
- "country": "CA"
}
}, - "rate": {
- "package_type": "SMALL",
- "service_type": "SAMEDAY",
- "currency": "CAD",
- "options": [ ],
- "options_total_price": 0,
- "delivery_price": 10,
- "total_price": 10
}, - "notes": "Ask concierge for elevator access",
- "reference": "order #9000",
- "reference2": "order #9000",
- "tracking_number": "9m4e2mr0ui3e8a215n4g",
- "complete_after": "2020-05-06T21:00:00.000Z",
- "complete_before": "2020-05-07T03:00:00.000Z",
- "created_at": "2020-05-06T05:29:19.472Z",
- "updated_at": "2020-05-06T05:29:19.472Z"
}
]
Create label with specific package and service type.
package_type required | string Enum: "SMALL" "MEDIUM" "LARGE" "EXTRA_LARGE" One of the package types returned when fetching rates. |
service_type required | string Enum: "SAMEDAY" "NEXTDAY" One of the service types returned when fetching rates. |
business_name | string Business name on whose behalf package is being delivered. In the case of a 3PL this would be the merchant business name. Is used in communication with client via SMS, etc. |
required | object (Recipient with Phone) An individual receiving or sending a package. |
required | Recipient with Phone (object) or Recipient with Email (object) (Recipient) An individual receiving or sending a package. |
signature_required | boolean (signatureRequired) The customer must provide their signature on delivery through the driver phone application. Requiring a signature will affect the rate for the delivery For condos:
|
notes | string Specific notes about delivery location for driver. |
order_number | string Order number from client's system. |
shipment_id | string Shipment id for a group of orders from client's system. |
reference | string Reference # or ID on the client side in case of any issues. Primarily to be used by our dispatcher to reach out to client but can also be used by client to attach specific metadata to label. |
reference2 | string Secondary reference # or ID on the client side in case of any issues. Can be used by client to attach specific metadata to label. |
tracking_number | string Optional unique tracking number. If provided, then the tracking number will be set to the given value. Otherwise it will be randomly generated. |
pickup_location_slug | string Identifier for the pickup location of this package. |
{- "package_type": "SMALL",
- "service_type": "SAMEDAY",
- "business_name": "Acme Corporation",
- "origin": {
- "first_name": "Bob",
- "last_name": "Dylan",
- "phone": "416 647 8888",
- "address": {
- "line1": "222 Bay St",
- "city": "Toronto",
- "postal_code": "M5J 2W4",
- "province": "ON",
- "country": "CA"
}
}, - "destination": {
- "first_name": "Elton",
- "last_name": "John",
- "phone": "647 416 8888",
- "address": {
- "line1": "188 University Ave",
- "line2": "Unit 4303",
- "city": "Toronto",
- "postal_code": "M5T 1A1",
- "province": "ON",
- "country": "CA"
}
}, - "notes": "Ask concierge for elevator access",
- "order_number": "12345ABC",
- "shipment_id": "567890ABC",
- "reference": "order #9000",
- "reference2": "order #9000"
}
{- "id": "bqofiflh5s5id0diioug",
- "package_type": "SMALL",
- "service_type": "SAMEDAY",
- "business_name": "Acme Corporation",
- "origin": {
- "first_name": "Bob",
- "last_name": "Dylan",