Unified.to · Schema

ShippingShipment

IntegrationsUnified API

Properties

Name	Type	Description
carrier_id	string
created_at	string
customs	object
from_address	object
id	string
insurance	object
is_adult_signature_required	boolean
is_international	boolean
is_rate_guaranteed	boolean
is_return	boolean
is_signature_required	boolean
label_id	string
order_id	string
original_shipment_id	string
packages	object
rate_amount	number
rate_currency	string
rate_estimated_days	number
rate_estimated_delivery_at	string
rate_id	string
rate_service_name	string
raw	object
reference_number	string
return_address	object
return_authorization_number	string
return_reason	string
return_type	string
service_code	string
shipped_at	string
special_instructions	object
status	string
to_address	object
tracking_id	string
updated_at	string
warehouse_location_id	string
warehouse_location_name	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ShippingShipment",
  "title": "ShippingShipment",
  "properties": {
    "carrier_id": {
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "customs": {
      "$ref": "#/components/schemas/property_ShippingShipment_customs"
    },
    "from_address": {
      "$ref": "#/components/schemas/property_ShippingShipment_from_address"
    },
    "id": {
      "type": "string"
    },
    "insurance": {
      "$ref": "#/components/schemas/property_ShippingShipment_insurance"
    },
    "is_adult_signature_required": {
      "type": "boolean"
    },
    "is_international": {
      "type": "boolean"
    },
    "is_rate_guaranteed": {
      "type": "boolean"
    },
    "is_return": {
      "type": "boolean"
    },
    "is_signature_required": {
      "type": "boolean"
    },
    "label_id": {
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "original_shipment_id": {
      "type": "string"
    },
    "packages": {
      "$ref": "#/components/schemas/property_ShippingShipment_packages"
    },
    "rate_amount": {
      "type": "number"
    },
    "rate_currency": {
      "type": "string"
    },
    "rate_estimated_days": {
      "type": "number"
    },
    "rate_estimated_delivery_at": {
      "format": "date-time",
      "type": "string"
    },
    "rate_id": {
      "type": "string"
    },
    "rate_service_name": {
      "type": "string"
    },
    "raw": {
      "additionalProperties": true,
      "type": "object"
    },
    "reference_number": {
      "type": "string"
    },
    "return_address": {
      "$ref": "#/components/schemas/property_ShippingShipment_return_address"
    },
    "return_authorization_number": {
      "type": "string"
    },
    "return_reason": {
      "type": "string"
    },
    "return_type": {
      "enum": [
        "CUSTOMER",
        "VENDOR",
        "WARRANTY",
        "DEFECTIVE",
        "OTHER"
      ],
      "type": "string",
      "x-speakeasy-unknown-values": "allow"
    },
    "service_code": {
      "type": "string"
    },
    "shipped_at": {
      "format": "date-time",
      "type": "string"
    },
    "special_instructions": {
      "$ref": "#/components/schemas/property_ShippingShipment_special_instructions"
    },
    "status": {
      "enum": [
        "PENDING",
        "PROCESSING",
        "IN_TRANSIT",
        "DELIVERED",
        "EXCEPTION",
        "CANCELLED",
        "LABEL_CREATED",
        "PICKED_UP",
        "OUT_FOR_DELIVERY",
        "DELIVERY_ATTEMPTED",
        "RETURNED_TO_SENDER",
        "HELD_AT_LOCATION",
        "CUSTOMS_CLEARANCE",
        "EXCEPTION_RESOLVED"
      ],
      "type": "string",
      "x-speakeasy-unknown-values": "allow"
    },
    "to_address": {
      "$ref": "#/components/schemas/property_ShippingShipment_to_address"
    },
    "tracking_id": {
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "warehouse_location_id": {
      "type": "string"
    },
    "warehouse_location_name": {
      "type": "string"
    }
  },
  "type": "object"
}