Skip to main content
POST
Create a shipment
Key: Write Scope: Company

Authorizations

Authorization
string
header
required

Use your Primo API key in the Authorization header as Bearer <API_KEY>.

Body

application/json
fromAddress
object
required
toAddress
object
required
parcel
object
required
hasInsurance
boolean
required
value
integer
required
Required range: x <= 9007199254740991
content
object[]
required
billingProfileId
string
required
Minimum string length: 1
reason
enum<string> | null
Available options:
ONBOARDING,
OFFBOARDING,
RENEWAL,
SEND_TO_EMPLOYEE,
SEND_TO_OFFICE,
RECYCLE,
REPAIR,
RESELL,
OTHER,
BOX
comment
string | null
notificationEmails
string[]
createBoxShipment
boolean

Response

default - application/json
success
boolean
required