Tyson Foods · Schema

Tyson Foods Shipment

A shipment record in the Tyson Foods B2B trading partner system (Advance Ship Notice / ASN)

B2B IntegrationEDIFoodFortune 100Supply Chain

Properties

Name Type Description
id string Unique shipment identifier
orderId string Associated purchase order ID
carrier string Shipping carrier name
trackingNumber string Carrier tracking number
status string Current shipment status
shipDate string Date the shipment was dispatched
estimatedDeliveryDate string Estimated delivery date
actualDeliveryDate string Actual delivery date (when status is delivered)
items array Items included in this shipment
View JSON Schema on GitHub

JSON Schema

tyson-foods-shipment-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.tysonfoods.com/schemas/shipment",
  "title": "Tyson Foods Shipment",
  "description": "A shipment record in the Tyson Foods B2B trading partner system (Advance Ship Notice / ASN)",
  "type": "object",
  "required": ["id", "orderId", "status"],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique shipment identifier"
    },
    "orderId": {
      "type": "string",
      "description": "Associated purchase order ID"
    },
    "carrier": {
      "type": "string",
      "description": "Shipping carrier name"
    },
    "trackingNumber": {
      "type": "string",
      "description": "Carrier tracking number"
    },
    "status": {
      "type": "string",
      "enum": ["created", "picked_up", "in_transit", "out_for_delivery", "delivered", "exception"],
      "description": "Current shipment status"
    },
    "shipDate": {
      "type": "string",
      "format": "date",
      "description": "Date the shipment was dispatched"
    },
    "estimatedDeliveryDate": {
      "type": "string",
      "format": "date",
      "description": "Estimated delivery date"
    },
    "actualDeliveryDate": {
      "type": "string",
      "format": "date",
      "description": "Actual delivery date (when status is delivered)"
    },
    "items": {
      "type": "array",
      "description": "Items included in this shipment",
      "items": {
        "type": "object",
        "properties": {
          "productId": {"type": "string"},
          "quantity": {"type": "integer"},
          "lotNumber": {"type": "string"},
          "expirationDate": {"type": "string", "format": "date"}
        }
      }
    }
  }
}