---
updatedAt: 2025-04-24T20:27:56.000Z
agentTools:
  projectIndex: https://api-docs.shippedsuite.com/llms.txt
---

# /v1/shipments

Creates or updates a Shipment

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Shipped Suite API",
    "description": "API provides access to Shipped Suite functions",
    "contact": {
      "name": "Steven Ou",
      "email": "steven@invisiblecommerce.com"
    },
    "version": "v1"
  },
  "servers": [
    {
      "url": "//api.shippedsuite.com/"
    }
  ],
  "security": [
    {
      "secretKey": []
    }
  ],
  "tags": [
    {
      "name": "Shipments",
      "description": "Operations about Shipments"
    }
  ],
  "paths": {
    "/v1/shipments": {
      "post": {
        "tags": [
          "Shipments"
        ],
        "description": "Creates or updates a Shipment",
        "operationId": "postV1Shipments",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/postV1Shipments"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Creates or updates a Shipment",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Shipment"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "postV1Shipments"
      }
    }
  },
  "components": {
    "schemas": {
      "Shipment": {
        "required": [
          "external_id",
          "shipment_items",
          "tracking_number"
        ],
        "type": "object",
        "properties": {
          "external_id": {
            "type": "string",
            "description": "Unique ID of Shipment in partner platform",
            "example": "9477990309572"
          },
          "tracking_number": {
            "type": "string",
            "description": "Tracking number associated with the Shipment",
            "example": "1Z71E8390396779841"
          },
          "shipment_items": {
            "type": "array",
            "description": "Collection of ShipmentItems belonging to the Shipment",
            "items": {
              "$ref": "#/components/schemas/ShipmentItem"
            }
          }
        },
        "description": "Shipment model"
      },
      "ShipmentItem": {
        "required": [
          "external_id",
          "external_order_item_id",
          "quantity"
        ],
        "type": "object",
        "properties": {
          "external_id": {
            "type": "string",
            "description": "Unique ID of ShipmentItem in partner platform",
            "example": "769209090444"
          },
          "external_order_item_id": {
            "type": "string",
            "description": "Unique ID of ShipmentItem's OrderItem in partner platform",
            "example": "10312518631616"
          },
          "quantity": {
            "type": "integer",
            "description": "Quantity of OrderItem in ShipmentItem",
            "format": "int32",
            "example": 1
          }
        }
      },
      "postV1Shipments": {
        "required": [
          "courier_name",
          "external_id",
          "external_order_id",
          "fulfilled_at",
          "shipment_items",
          "tracking_number"
        ],
        "type": "object",
        "properties": {
          "external_order_id": {
            "type": "string",
            "description": "Unique ID of Order the Shipment belongs to in partner platform",
            "example": "12443"
          },
          "external_id": {
            "type": "string",
            "description": "Unique ID of Shipment in partner platform",
            "example": "9477990309572"
          },
          "courier_name": {
            "type": "string",
            "description": "Name of the Shipment's Courier",
            "example": "USPS"
          },
          "tracking_number": {
            "type": "string",
            "description": "Tracking number for the Shipment",
            "example": "420945639300110923000806702489"
          },
          "tracking_url": {
            "type": "string",
            "description": "URL to track the Shipment",
            "example": "https://tools.usps.com/go/TrackConfirmAction?tLabels=420945639300110923000806702489"
          },
          "fulfilled_at": {
            "type": "string",
            "description": "Date and time the Shipment was fulfilled. RFC 3339.",
            "format": "date-time",
            "example": "2021-08-27T09:12:28Z"
          },
          "shipment_items": {
            "type": "array",
            "items": {
              "required": [
                "external_id",
                "external_order_item_id",
                "quantity"
              ],
              "type": "object",
              "properties": {
                "external_id": {
                  "type": "string",
                  "description": "Unique ID of ShipmentItem in partner platform",
                  "example": "769209090444"
                },
                "external_order_item_id": {
                  "type": "string",
                  "description": "Unique ID of ShipmentItem's OrderItem in partner platform",
                  "example": "10312518631616"
                },
                "quantity": {
                  "type": "integer",
                  "description": "Quantity of OrderItem in ShipmentItem",
                  "format": "int32",
                  "example": 1
                }
              }
            }
          }
        },
        "description": "Creates or updates a Shipment"
      }
    },
    "securitySchemes": {
      "secretKey": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    }
  },
  "x-original-swagger-version": "2.0"
}
```