channel.package.op

Act on a marketplace package: status (preparing/invoiced), unsupplied (penalty acknowledged), split, invoice hand-off, cargo (carrier/box/warehouse/extend/own-carrier).

Machine-readable body schema: /schemas/routes/channel.package.op.json.

Body

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "packageId": {
      "type": "string",
      "pattern": "^pkg_[0-9A-HJKMNP-TV-Z]{26}$"
    },
    "status": {
      "type": "string",
      "enum": [
        "preparing",
        "invoiced",
        "shipped",
        "delivered",
        "returned"
      ]
    },
    "invoiceNumber": {
      "type": "string",
      "maxLength": 32
    },
    "lines": {
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "orderLineId": {
            "type": "string",
            "pattern": "^oln_[a-zA-Z0-9]{1,32}$"
          },
          "qty": {
            "type": "integer",
            "minimum": 1,
            "maximum": 99
          }
        },
        "required": [
          "orderLineId",
          "qty"
        ],
        "additionalProperties": false
      }
    },
    "reason": {
      "type": "string",
      "maxLength": 16
    },
    "acknowledgePenalty": {
      "type": "boolean",
      "const": true
    },
    "groups": {
      "minItems": 1,
      "maxItems": 10,
      "type": "array",
      "items": {
        "minItems": 1,
        "maxItems": 50,
        "type": "array",
        "items": {
          "type": "string",
          "pattern": "^oln_[a-zA-Z0-9]{1,32}$"
        }
      }
    },
    "invoiceLink": {
      "type": "string",
      "maxLength": 300,
      "format": "uri"
    },
    "invoiceDateTime": {
      "type": "string",
      "maxLength": 40
    },
    "carrier": {
      "type": "string",
      "maxLength": 24
    },
    "boxQuantity": {
      "type": "integer",
      "minimum": 1,
      "maximum": 99
    },
    "deci": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000
    },
    "warehouseId": {
      "type": "string",
      "maxLength": 24
    },
    "extendDays": {
      "type": "integer",
      "minimum": 1,
      "maximum": 3
    },
    "trackingInfo": {
      "type": "string",
      "maxLength": 300
    },
    "trackingIsPhone": {
      "type": "boolean"
    },
    "manual": {
      "type": "string",
      "enum": [
        "delivered",
        "returned"
      ]
    }
  },
  "additionalProperties": false
}
Generated from the live platform registries at build time — reference pages cannot go stale. Markdown variant: /reference/routes/channel.package.op.md