import { JsonSchema } from '@redocly/developer-portal/ui';

The Shipment Object

The Shipment Object is the backbone of the Shipping API. It represents a grouping of items that are transported together from a starting point to a final destination. This can include one or multiple parcels.

The type of shipment can be classified as either FORWARD or REVERSE. A FORWARD shipment indicates the movement of items from a merchant to a customer, while a REVERSE shipment is the opposite, representing the return of items from a customer to a merchant.

Each shipment is given two distinct identification codes, one generated by Carriyo called the Shipment ID and the other, a Partner Shipment Reference which is provided by the merchant themselves.