> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.quivo.co/llms.txt > Use this file to discover all available pages before exploring further. # Get shipment > Get details for a booked shipment by its ID. ## OpenAPI ````yaml /openapi.json get /shipments/{bookedShipmentId} openapi: 3.0.1 info: title: Connector version: 80f7edc, 2026-01-23T12:01:00Z description: Enhanced Quivo API documentation with additional descriptions and examples contact: name: Quivo Support email: support@quivo.co url: https://quivo.co license: name: Proprietary url: https://quivo.co/terms termsOfService: https://quivo.co/terms servers: - url: https://api.quivo.co/ description: Production API server for Quivo Connector security: [] tags: - name: addresses description: Manage stored addresses in the seller's address book - name: apiKeyRequests description: Request and manage API keys - name: articles description: Create and manage product articles - name: audits description: Access audit logs and history - name: bundles description: Manage product bundles - name: carriers description: Get carrier information - name: contacts description: Manage contact information - name: countries description: Get country information - name: currencies description: Get currency information - name: customerInquiries description: Manage customer inquiries - name: dashboards description: Access dashboard data - name: files description: Manage file uploads and downloads - name: fulfillmentPlans description: Manage fulfillment plans - name: inbounds description: Manage inbound shipments - name: items description: Monitor and manage inventory items - name: languages description: Get language information - name: notifications description: Manage notifications - name: orders description: Create and manage fulfillment orders - name: ping description: Health check endpoint - name: returnApp description: Manage return applications - name: returnLinks description: Manage return links - name: returns description: Manage returns - name: sellers description: Get seller information - name: shipments description: Book and manage shipments - name: shippingServiceGroups description: Get shipping service groups - name: shopOrders description: Manage shop orders - name: shops description: Manage shops - name: status description: Get system status - name: storedAddresses description: Manage stored addresses - name: subscriptionPackages description: Manage subscription packages - name: subscriptions description: Manage webhook subscriptions - name: track description: Track shipments - name: transports description: Manage transport services - name: users description: Manage users - name: warehouses description: Get warehouse information paths: /shipments/{bookedShipmentId}: get: tags: - shipments summary: Get shipment description: Get details for a booked shipment by its ID. operationId: shipmentShipmentGet parameters: - name: bookedShipmentId in: path required: true schema: type: integer format: int64 description: The unique identifier for a booked shipment. responses: '200': description: >- Returns shipment details including tracking information, label URLs, and current status. content: application/json: schema: $ref: '#/components/schemas/BookedShipmentGet' '400': description: >- Bad request - the request payload is invalid, missing required fields, or contains invalid data. '401': description: >- Unauthorized - authentication credentials are missing, invalid, or expired. '404': description: >- Not found - the requested resource does not exist or is not accessible. '500': description: Internal server error - an unexpected error occurred on the server. components: schemas: BookedShipmentGet: type: object properties: sellerId: type: integer format: int64 description: The unique identifier for the seller shippingServiceId: type: integer format: int64 description: The unique identifier for the shippingservice request: $ref: '#/components/schemas/ShippingOrderGet' documents: type: array items: $ref: '#/components/schemas/ShipmentDocumentGet' description: Array of document items trackingDetails: type: array items: $ref: '#/components/schemas/TrackingDetailGet' description: Tracking information or tracking enabled status id: type: integer format: int64 description: The unique identifier for the id created: type: string format: date-time description: Timestamp when the item was created requestId: type: string description: The unique identifier for the request trackingNumber: type: string description: Tracking information or tracking enabled status additionalTrackingNumbers: type: array items: $ref: '#/components/schemas/AdditionalTrackingNumberGet' description: Tracking information or tracking enabled status returnTrackingNumber: type: string description: Tracking information or tracking enabled status additionalReturnTrackingNumbers: type: array items: $ref: '#/components/schemas/AdditionalTrackingNumberGet' description: Tracking information or tracking enabled status shipmentIdentifier: type: string description: The unique identifier for the shipmententifier cancelledAt: type: string format: date-time description: The cancelled at timestamp carrierCancelledAt: type: string format: date-time description: Carrier identifier or information shipTo: $ref: '#/components/schemas/ShipmentDeliveryAddress' shipFrom: $ref: '#/components/schemas/ShipmentDeliveryAddress' parcelWeight: type: number description: Weight value parcelReference: type: string description: Reference number or identifier for the parcel piiDataRemoved: type: boolean description: Boolean flag indicating pii data removed contentDescription: type: string description: Description text trackingLink: type: string description: Tracking information or tracking enabled status returnTrackingLink: type: string description: Tracking information or tracking enabled status carrierSlug: type: string description: Carrier identifier or information carrierName: type: string description: The name of the carrier direction: type: string description: The direction value description: >- Complete booked shipment information with all details. Contains shipment identifiers, addresses, dimensions, weight, carrier information, tracking details, and status. ShippingOrderGet: type: object properties: shipTo: $ref: '#/components/schemas/ShipmentDeliveryAddress' shipFrom: $ref: '#/components/schemas/ShipmentDeliveryAddress' reference: type: string description: Reference number or identifier for the item grossWeightKg: type: number description: >- The gross weight of the shipment's main parcel in kg, which does not include the weight of any additional parcels. lengthM: type: number description: The length of the shipment's main parcel in meters. widthM: type: number description: The width of the shipment's main parcel in meters. heightM: type: number description: The height of the shipment's main parcel in meters. totalWeight: type: number description: >- The total weight of the shipment in kg, which is the sum of the weight of the main as well as all additional parcels in this shipment. totalVolume: type: number description: >- The total volume of the shipment in m3, which is the sum of the volume of the main as well as all additional parcels in this shipment. shipmentDate: type: string format: date-time description: The shipment date date invoiceNumber: type: string description: Number value invoiceDate: type: string format: date-time description: The invoice date date includeReturnLabel: type: boolean description: Boolean flag indicating include return label trackingEnabled: type: boolean description: Indicates whether tracking is enabled userIdentifier: type: string description: The unique identifier for the userentifier cashOnDeliveryAmount: type: number description: Amount value cashOnDeliveryCurrency: $ref: '#/components/schemas/Currency' customsPositions: type: array items: $ref: '#/components/schemas/ExportPositionGet' description: Custom attributes or data transportInsuranceAmount: type: number description: Amount value termsOfTrade: type: string enum: - DAP - DDP description: 'The terms of trade. Possible values: DAP, DDP' additionalParcels: type: array items: $ref: '#/components/schemas/ShipmentParcelGet' description: Array of additional parcel orderReference: type: string description: Reference for the order from the customer shop system description: Response object containing shippingorder details ShipmentDocumentGet: type: object properties: shipmentDocumentId: type: integer format: int64 description: The unique identifier for the shipmentdocument type: type: string enum: - LABEL - EXPORT_DOCUMENT - NON_PRINT_EXPORT_DOCUMENT - MANIFEST_DOCUMENT - RETURN_LABEL description: The type or category of the item description: Response object containing shipmentdocument details TrackingDetailGet: type: object properties: status: type: string description: The current status of the item created: type: string format: date-time description: Timestamp when the item was created message: type: string description: Message content rawTag: type: string description: The raw tag description: Response object containing trackingdetail details AdditionalTrackingNumberGet: type: object properties: trackingNumber: type: string description: Tracking information or tracking enabled status reference: type: string description: Reference number or identifier for the item description: Response object containing additionaltrackingnumber details ShipmentDeliveryAddress: type: object properties: name: type: string description: >- Name of the recipient.
Usually this is the first and lastname of the recipient. company: type: string description: Name of the company. phone: type: string description: >- Phone number of the recipient.
The phone number is usually optional. email: type: string description: E-Mail address of the recipient. zip: type: string description: >- ZIP Code of the recipient
The ZIP code is optional for some countries, but required for most. It is optional when latitude and longitude coordinates are provided. city: type: string description: >- City of the recipient.
This field is optional only when latitude and longitude coordinates are provided. state: type: string description: >- State of the recipient.
This is not required for most countries, but required in some (eg: United States). countryIso2: type: string description: >- Country Code.
This field is optional only when latitude and longitude coordinates are provided. street: type: string description: >- Street (or Address Line 1) of the recipient.
This field is optional only when latitude and longitude coordinates are provided. street2: type: string description: >- Street (or Address Line 2) of the recipient.
This field is optional. latitude: type: number description: >- Latitude of the address.
This field is optional and used for some carriers to optimize the delivery process. format: double longitude: type: number description: >- Longitude of the address.
This field is optional and used for some carriers to optimize the delivery process. format: double description: 'The ' Currency: type: object properties: currencyCode: type: string description: Currency code defaultFractionDigits: type: integer format: int32 description: The default fraction digits numeric value numericCode: type: integer format: int32 description: Code or identifier displayName: type: string description: The name of the display symbol: type: string description: The symbol value numericCodeAsString: type: string description: Code or identifier description: Currency information ExportPositionGet: type: object properties: currency: $ref: '#/components/schemas/Currency' quantity: type: integer format: int32 description: Quantity or amount origin: type: string enum: - AF - AX - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - JM - JP - JE - JO - KZ - KE - KI - KP - KR - XK - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MK - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - BL - SH - KN - LC - MF - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SK - SI - SB - SO - ZA - GS - ES - LK - SD - SR - SJ - CW - BQ - SX - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW description: 'The origin. Possible values: AF, AX, AL, DZ, AS (and 244 more)' tariff: type: string description: The tariff value warehouseSku: type: string description: Stock Keeping Unit (SKU) identifier contentDescription: type: string description: Description text unNumber: type: string description: Number value description: type: string description: Description text pieceNetCustomsValue: type: number description: The piece net customs value value pieceNetWeightKg: type: number description: Weight value description: Response object containing exportposition details ShipmentParcelGet: required: - weight type: object properties: weight: minimum: 0 exclusiveMinimum: true type: number description: Parcel weight (kilograms) including packaging. length: type: number description: >- Parcel package length (meters)
This field will be considered only if width and height are filled as well. width: type: number description: >- Parcel package width (meters)
This field will be considered only if length and height are filled as well. height: type: number description: >- Parcel package height (meter)
This field will be considered only if length and width are filled as well. reference: type: string description: Parcel package reference for the current shipment (meter) description: Response object containing shipmentparcel details ````