Carriyo Hub
Authentication API Reference
Shipment 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
Create Reverse Shipment
post
draft-shipment-api
Update Draft Shipment
patch
Confirm Draft Shipment
patch
Create Draft Shipment
post
Models
Bulk Shipment Status Response
Carrier Account Request
Carrier Account Response
Carriyo Response Status
Collection
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 Request
Reverse Shipment Response
Shipment Draft Request
Shipment Draft Response
Shipment Request
Shipment Response
Update Parcels Request
delivery
dimension
item
parcel-output
payment
weight
Powered by Stoplight

Carriyo Shipment API

  • Version: 1.0
  • Host: demo-api.carriyo.com
  • Protocols: https
More Info

You can use the Carriyo Shipment API to create and manage shipments with any one of carriers supported by Carriyo.

A shipment is defined as single unit of items that shipped from the same origin to the same the destination, to be shipped together at the same time. A shipment can contain multiple parcels all shipped together to the same recepient.

A shipment is identified by an Carriyo generated shipment-id. It can also be identified by the client provided unique shipment reference, called as the partner_shipment_reference.

We currently support the following carriers

  1. Fetchr
  2. Aramex
  3. UPS
  4. Quiqup
  5. Naqel
  6. SMSA
  7. Vaal
  8. Fodel
  9. Shipa
  10. Fareye

All API endpoints require OAuth access token to be passed ‘Authorization’ as a Bearer Token.