---
updatedAt: 2025-08-20T14:11:03.000Z
agentTools:
  projectIndex: https://documentation.safecube.ai/llms.txt
---

# Get multiple shipments

Endpoint that searchs for shipments in the web application and returns the public shipment link.

Endpoint that searchs for shipments in the web application and returns the public shipment link.

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Safecube Shipment Management API",
    "version": "1.0.0",
    "description": "Welcome to the documentation of the Safecube Shipment Management API\n<h1>Compatibility guidelines</h1> <p>The HTTP API is versioned with a single number, which is currently 1</p> <p>This number symbolizes the major version number. New features can be added to the API in the same version number if there is no breaking change.</p> <p>The version number is present in the url, for instance <strong>/safecube/api/v1</strong> for the current version.\n<h1>Documentation</h1> <p>You can find the complete documentation for our API at <a href='https://documentation.safecube.ai/'>Safecube documentation</a>.</p>\n<h1>Authentication</h1> <p>Every endpoints of this API require authentication using an API key with a specific authorization.</p> <p>If you don't have an API Key and you need to use the Safecube Shipment Management API, you need to ask Sinay to have one.</p> <p>To use the API Key, you must add a header named <strong>API_KEY</strong> with your API Key as a value.</p> <h1>Test the API with Swagger-ui</h1> <p>To test the API using Swagger-ui, you must click on the button <strong>Authorize</strong> and then fill the <strong>apiKey</strong> field and click on <strong>Authorize</strong>.</p> <p>Swagger-ui will then use the api key automatically in each request.</p> <p>On every endpoints, you can click on <strong>Try it out</strong>, you can modify the body and then click on <strong>Execute</strong></p> <p>You will be able to see the response.</p>"
  },
  "servers": [
    {
      "url": "https://api.sinay.ai/safecube/api/v1"
    }
  ],
  "security": [
    {
      "ApiKey": []
    }
  ],
  "paths": {
    "/public/shipments/search": {
      "post": {
        "tags": [
          "Shipments"
        ],
        "summary": "Get multiple shipments",
        "description": "Endpoint that searchs for shipments in the web application and returns the public shipment link.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PublicBulkShipments"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShipmentSearchResponse"
                }
              }
            }
          },
          "204": {
            "description": "No Content (shipments not found or empty)"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "PublicBulkShipments": {
        "type": "object",
        "properties": {
          "shipmentNumbers": {
            "type": "array",
            "items": {
              "description": "The shipment number is a container number, Booking number or Bill of Lading number.",
              "type": "string"
            }
          }
        },
        "required": [
          "shipmentNumbers"
        ],
        "example": {
          "shipmentNumbers": [
            "HLCUBO12208AXHI9"
          ]
        }
      },
      "ShipmentSearchResponse": {
        "type": "object",
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentResult"
            }
          },
          "notFoundResults": {
            "description": "If you search for a shipment that does not exist in your web application, it will appear in this list.",
            "type": "array",
            "items": {
              "description": "Shipment number.",
              "type": "string"
            }
          }
        },
        "example": {
          "results": [
            {
              "id": "55aa63de-f8f6-41ac-a105-4f3bfb015bea",
              "shipmentNumber": "GCXU5630216",
              "sealine": "COSU",
              "sealineName": "COSCO",
              "link": "https://test-dev.safecube.ai/shared/shipment?token=85070eb8-1387-47cb-be2e-f05323ebab45"
            }
          ],
          "notFoundResults": []
        }
      },
      "ShipmentResult": {
        "type": "object",
        "description": "Main information about the shipment.",
        "properties": {
          "id": {
            "description": "The shipment uuid is a unique identifier of the shipment in your application. This field can be reused as an input for the DELETE /shipments endpoint.",
            "type": "string",
            "format": "uuid"
          },
          "shipmentNumber": {
            "description": "The shipment number is a container number, Booking number or Bill of Lading number.",
            "type": "string"
          },
          "sealine": {
            "description": "The SCAC code is a 4 letters code that is used to identify a sealine. Find all our supported sealines in <a href='https://documentation.safecube.ai/reference/supported-sealines'>Safecube documentation</a>.",
            "type": "string"
          },
          "sealineName": {
            "description": "Full text sealine name.",
            "type": "string"
          },
          "link": {
            "description": "Shipment public sharing link. Share it with someone to show him all the shipment data, without any login needed. It can also be used for iframe integration.",
            "type": "string",
            "format": "uri"
          }
        },
        "example": {
          "id": "55aa63de-f8f6-41ac-a105-4f3bfb015bea",
          "shipmentNumber": "GCXU5630216",
          "sealine": "COSU",
          "sealineName": "COSCO",
          "link": "https://app.safecube.ai/shared/shipment?token=85070eb8-1387-47cb-be2e-f05323ebab45"
        }
      }
    },
    "securitySchemes": {
      "ApiKey": {
        "type": "apiKey",
        "in": "header",
        "name": "API_KEY"
      }
    }
  }
}
```