magento · Schema

Shipment

A shipment record tracking the physical dispatch of order items.

Properties

Name	Type	Description
entity_id	integer	Numeric shipment entity ID.
order_id	integer	Numeric entity ID of the parent order.
increment_id	string	Human-readable shipment number.
created_at	string	ISO 8601 timestamp when the shipment was created.
tracks	array	Tracking information for this shipment.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Shipment",
  "title": "Shipment",
  "type": "object",
  "description": "A shipment record tracking the physical dispatch of order items.",
  "properties": {
    "entity_id": {
      "type": "integer",
      "description": "Numeric shipment entity ID."
    },
    "order_id": {
      "type": "integer",
      "description": "Numeric entity ID of the parent order."
    },
    "increment_id": {
      "type": "string",
      "description": "Human-readable shipment number."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the shipment was created."
    },
    "tracks": {
      "type": "array",
      "description": "Tracking information for this shipment.",
      "items": {
        "type": "object",
        "properties": {
          "carrier_code": {
            "type": "string",
            "description": "Carrier code (e.g. ups, fedex, usps)."
          },
          "title": {
            "type": "string",
            "description": "Human-readable carrier name."
          },
          "track_number": {
            "type": "string",
            "description": "Tracking number provided by the carrier."
          }
        }
      }
    }
  }
}