Carriyo API Hub
Authentication API Reference
Shipments API Reference
Returns API Reference
No results found.
shipment-api
Create Shipment
post
Update Parcels
put
Ready to Ship
patch
Reassign Shipment
patch
Reprocess Shipment
put
Get Label
get
Get Shipment
get
Get Bulk Shipment Statuses
get
webhook
Client Webhook / Carriyo Callback
post
reverse-shipment-api
Update Parcels Reverse Shipment
put
Ready to Ship Reverse Shipment
patch
Get Label Reverse Shipment
get
Create Reverse Shipment
post
Get Bulk Reverse Shipment Statuses
get
Get Reverse Shipment
get
Reassign Reverse Shipment
patch
Reprocess Reverse Shipment
put
draft-shipment-api
Update Draft Shipment
patch
Confirm Draft Shipment
patch
Create Draft Shipment
post
draft-reverse-shipment-api
Confirm Draft Reverse Shipment
patch
Create Draft Reverse Shipment
post
Update Draft Reverse Shipment
patch
Models
Bulk Shipment Status Response
Carrier Account Request
Carrier Account Response
Carriyo Response Status
Collection
Create shipment error response
Custom Attributes Request
Dropoff Draft Request
Dropoff Request
Dropoff Response
Label
Parcel Item
Parcel Request
Personal ID
Pickup Draft Request
Pickup Request
Pickup Response
Post Shipping Info
References Request
References Response
Return Collection
Return Payment
Return References
Reverse Shipment Response
Shipment Draft Request
Shipment Draft Response
Shipment Request
Update Parcels Request
delivery
dimension
item
parcel-output
payment
weight
Powered by Stoplight

References Request

Tenant provided references for a shipment. The partner_shipment_reference is not mandatory but is expected to be unique. If partner_shipment_reference is not passed, then the partner_order_reference is used as the partner_shipment_reference. The partner_shipment_reference is useful to provide a tenant defined reference for each shipment if a single order has multiple shipments.

object
partner_order_reference
string
required
partner_shipment_reference
string
alternate_reference
string
other_references
array[string]