[2024-05] Create a Shipment

post

https://api.shippie.ca/api/2024-05/shipments

Creates a shipment, and returns the details about the shipment, along with a base64 label, and rate data.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

recipient

object

required

orderNumber

string

Unique e-commerce orderNumber, if not provided, will use Shippie generated order numbers

source

string

enum

Defaults to rest

Source of this shipment, defaults to rest

serviceType

string

enum

The shipment's requested service type. Will use the cheapest option if not provided

Allowed:

originId

string

Location ID of where this shipment is picked up from

destination

object

required

origin

object

Optional origin address for the order. If provided, the origin location will be created if it does not already exist.

weight

object

required

dimensions

object

lineItems

array of objects

All Items/Products contained in this shipment

lineItems

notes

string

Any notes about the package or destination, include buzzer codes here

customerNotes

string

Any notes from the customer

signatureRequired

boolean

Whether a signature is required upon delivery

Responses

400

bad input parameter

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200ok