Carriyo Products API

Download OpenAPI specification

The Carriyo Products API lets you manage your product catalogue in Carriyo. Products are referenced by shipments, orders, returns, and inventory — keeping your catalogue in Carriyo up to date ensures accurate downstream data.

Key Resources

  • Products — Create, read, update, and delete products in your catalogue

What You Can Do

  • List and search your catalogue with filtering, sorting, pagination, and free-text search
  • Look up individual products by Carriyo product_id , your product_ref , or sku
  • Create, update, and delete products one at a time, or in bulk
  • Capture cross-border attributes like HS code, country of origin, material composition, dangerous goods, and battery details
  • Attach custom metadata via carriyo_metadata name/value pairs

Identifiers

Each product can be referenced by three identifiers:

Identifier Source Uniqueness
product_id Assigned by Carriyo Unique per tenant
product_ref Supplied by you Recommended unique within a merchant
sku Supplied by you Not guaranteed unique — lookups return an array