---
updatedAt: 2025-05-01T20:03:25.000Z
agentTools:
  projectIndex: https://developer.shippie.ca/llms.txt
---

# [2023-06] Get shipment details

Gets details about a shipment after a label has been created

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Shippie API",
    "description": "The Shippie API allows developers to build applications that interface with the Shippie platform.",
    "version": "3.1.0"
  },
  "servers": [
    {
      "url": "https://api.shippie.ca",
      "description": "The Shippie API allows developers to build applications that interface with the Shippie platform"
    }
  ],
  "security": [
    {
      "basicAuth": [
        "API_KEY",
        "API_SECRET"
      ]
    }
  ],
  "tags": [
    {
      "name": "Shipments",
      "description": "Use the Shipments API to track & cancel shipments"
    }
  ],
  "paths": {
    "/api/2023-06/shipments/{shipmentId}": {
      "summary": "Shipments API",
      "parameters": [
        {
          "$ref": "#/components/parameters/shipmentId"
        }
      ],
      "get": {
        "tags": [
          "Shipments"
        ],
        "summary": "[2023-06] Get shipment details",
        "description": "Gets details about a shipment after a label has been created",
        "responses": {
          "200": {
            "description": "ok",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseShipment"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    },
    "schemas": {
      "ShipmentId": {
        "type": "string"
      },
      "ResponseShipment": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "example": "XpMO8pW7xSzLPCqAJfmR"
          },
          "orderNumber": {
            "type": "string",
            "description": "Unique order number",
            "example": "S00001"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "created",
              "pickup",
              "pickedup",
              "transit",
              "delivered",
              "cancelled",
              "failed"
            ]
          },
          "recipient": {
            "$ref": "#/components/schemas/Recipient"
          },
          "destination": {
            "$ref": "#/components/schemas/Address"
          },
          "weight": {
            "$ref": "#/components/schemas/Weight"
          },
          "dimensions": {
            "$ref": "#/components/schemas/Dimensions"
          },
          "lineItems": {
            "type": "array",
            "description": "All Items/Products contained in this shipment",
            "items": {
              "type": "object",
              "description": "Items/Products contained in this shipment",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The unique identifier for this item/product"
                },
                "name": {
                  "type": "string",
                  "description": "The name of this item/product"
                },
                "quantity": {
                  "type": "string",
                  "description": "The quantity of this item/product in this shipment"
                },
                "unitPrice": {
                  "type": "number",
                  "description": "Unit price of this item/product"
                },
                "imageURL": {
                  "type": "string",
                  "description": "URL to the image of this item/product"
                },
                "sku": {
                  "type": "string",
                  "description": "SKU for this item/product"
                },
                "notes": {
                  "type": "string",
                  "description": "Notes about this item/product"
                },
                "weight": {
                  "$ref": "#/components/schemas/Weight"
                }
              }
            }
          },
          "notes": {
            "type": "string",
            "description": "Any notes about the package or destination, include buzzer codes here"
          },
          "signatureRequired": {
            "type": "boolean",
            "description": "Whether a signature is required upon delivery"
          },
          "created": {
            "type": "number",
            "format": "unix",
            "example": 1621469235082
          },
          "updated": {
            "type": "number",
            "format": "unix",
            "example": 1621469235082
          },
          "estimatedDeliveryDate": {
            "type": "string",
            "description": "Estimated delivery date in format (YYYY-MM-DDTHH:mm:ssZ)"
          }
        }
      },
      "Address": {
        "required": [
          "city",
          "country",
          "address1",
          "postalCode",
          "province"
        ],
        "properties": {
          "address1": {
            "type": "string",
            "example": "1 University Ave"
          },
          "address2": {
            "type": "string",
            "example": "unit 1501"
          },
          "postalCode": {
            "type": "string",
            "example": "M5J 2P1"
          },
          "province": {
            "type": "string",
            "example": "Ontario"
          },
          "city": {
            "type": "string",
            "example": "Toronto"
          },
          "country": {
            "type": "string",
            "example": "Canada"
          },
          "destinationType": {
            "type": "string",
            "description": "The type of destination defaults to residential",
            "default": "residential",
            "enum": [
              "residential",
              "business"
            ]
          }
        }
      },
      "Recipient": {
        "required": [
          "email",
          "fullName",
          "phone"
        ],
        "properties": {
          "fullName": {
            "type": "string",
            "example": "John Doe"
          },
          "phone": {
            "type": "string",
            "example": "+16475558888"
          },
          "email": {
            "type": "string",
            "example": "john.doe@gmail.com"
          }
        }
      },
      "Weight": {
        "properties": {
          "value": {
            "type": "number",
            "description": "weight value"
          },
          "units": {
            "type": "string",
            "example": "grams",
            "description": "units of weight, allowed units are pounds, ounces, or grams",
            "enum": [
              "grams",
              "ounces",
              "pounds"
            ]
          }
        }
      },
      "Dimensions": {
        "properties": {
          "length": {
            "type": "number",
            "description": "Length of package"
          },
          "width": {
            "type": "number",
            "description": "Width of package"
          },
          "height": {
            "type": "number",
            "description": "Height of package"
          },
          "units": {
            "type": "string",
            "description": "Units of measurement, allowed units are inches or centimeters",
            "example": "centimeters",
            "enum": [
              "centimeters",
              "inches"
            ]
          }
        }
      }
    },
    "parameters": {
      "shipmentId": {
        "in": "path",
        "name": "shipmentId",
        "schema": {
          "$ref": "#/components/schemas/ShipmentId"
        },
        "required": true,
        "description": "the ID of the shipment you want to retrieve",
        "example": "XpMO8pW7xSzLPCqAJfmR"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```