Shipment

Shipment record for a fulfilled order

RetailFashionApparelEcommerceAffiliateMarketplaceFortune 1000

Properties

Name	Type	Description
id	string	Shipment identifier
orderId	string	Associated order identifier
carrier	string	Shipping carrier
trackingNumber	string	Carrier tracking number
status	string	Shipment status
createdAt	string	Shipment creation time
estimatedDelivery	string	Estimated delivery date

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/urban-outfitters/refs/heads/main/json-schema/marketplace-api-shipment-schema.json",
  "title": "Shipment",
  "description": "Shipment record for a fulfilled order",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Shipment identifier",
      "example": "shipment-abc123"
    },
    "orderId": {
      "type": "string",
      "description": "Associated order identifier",
      "example": "order-xyz789"
    },
    "carrier": {
      "type": "string",
      "description": "Shipping carrier",
      "example": "UPS"
    },
    "trackingNumber": {
      "type": "string",
      "description": "Carrier tracking number",
      "example": "1Z999AA10123456784"
    },
    "status": {
      "type": "string",
      "description": "Shipment status",
      "enum": [
        "shipped",
        "in_transit",
        "delivered"
      ],
      "example": "shipped"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Shipment creation time",
      "example": "2025-03-17T09:00:00Z"
    },
    "estimatedDelivery": {
      "type": "string",
      "format": "date",
      "description": "Estimated delivery date",
      "example": "2025-03-20"
    }
  }
}