Shipment

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Shipment",
  "title": "Shipment",
  "type": "object",
  "properties": {
    "cancellation": {
      "description": "Cancellation status for the package, if one exists.",
      "$ref": "#/components/schemas/ShipmentCancellation"
    },
    "creationDate": {
      "type": "string",
      "description": "The date and time the shipment was created, formatted as an <a href=\"https://www.iso.org/iso-8601-date-and-time-format.html \" title=\"https://www.iso.org \" target=\"_blank\">ISO 8601</a> string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.  <br><br><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code> <br><b>Example:</b> <code>2018-08-20T07:09:00.000Z</code>"
    },
    "labelCustomMessage": {
      "type": "string",
      "description": "If supported by the selected shipping carrier, this field can contain optional seller text to be printed on the shipping label."
    },
    "labelDownloadUrl": {
      "type": "string",
      "description": "The direct URL the seller can use to download an image of the shipping label. By default, the file format is PDF. See <a href=\"/api-docs/sell/logistics/resources/shipment/methods/downloadLabelFile\">downloadLabelFile</a> for requesting different response file formats."
    },
    "labelSize": {
      "type": "string",
      "description": "The seller's desired label size. The support for multi-sized labels is shipping-carrier specific and if the size requested in the <b>creaateFromShippingQuote</b> call matches a size the carrier supports, the value will be represented here in the shipment. <br><br>Currently, the only valid value is: <code>4\"x6\"</code>"
    },
    "orders": {
      "type": "array",
      "description": "A list of one or more orders that will be shipped in the shipping package.",
      "items": {
        "$ref": "#/components/schemas/Order"
      }
    },
    "packageSpecification": {
      "description": "The weight and dimensions of the package.",
      "$ref": "#/components/schemas/PackageSpecification"
    },
    "rate": {
      "description": "The shipping rate that the seller has chosen to purchase for this shipment. Each rate, identified by a <b>rateId</b>, contains the offered base service, options, and shipping parameters that were selected for the package shipment.",
      "$ref": "#/components/schemas/PurchasedRate"
    },
    "returnTo": {
      "description": "The address and contact details that should be used for item returns. Sellers have the option to define a return address that is different from their <b>shipFrom</b> address. If not specified, the return address defaults to the <b>shipFrom</b> address in the shipping quote.",
      "$ref": "#/components/schemas/Contact"
    },
    "shipFrom": {
      "description": "The address and contact details for the origin of the package shipment.",
      "$ref": "#/components/schemas/Contact"
    },
    "shipmentId": {
      "type": "string",
      "description": "The unique eBay-assigned ID for the shipment. The ID is generated when the shipment is created by a call to <b>createFromShippingQuote</b>."
    },
    "shipmentTrackingNumber": {
      "type": "string",
      "description": "A unique carrier-assigned ID string that can be used to track the shipment."
    },
    "shipTo": {
      "description": "The address and contact details for the destination of the shipment.",
      "$ref": "#/components/schemas/Contact"
    }
  },
  "description": "This complex type defines a shipment for a specific package (for example, a box or letter). Shipments are always linked to a purchased shipping label. "
}