Shippo · Schema

TransactionCreateRequest

EcommerceLabelsLogisticsReturnsShippingTracking

Properties

Name Type Description
rate string Object ID of the rate to purchase
label_file_type string
metadata string
async boolean
View JSON Schema on GitHub

JSON Schema

shippo-transactioncreaterequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TransactionCreateRequest",
  "title": "TransactionCreateRequest",
  "type": "object",
  "required": [
    "rate",
    "label_file_type"
  ],
  "properties": {
    "rate": {
      "type": "string",
      "description": "Object ID of the rate to purchase"
    },
    "label_file_type": {
      "type": "string",
      "enum": [
        "PNG",
        "PNG_2.3x7.5",
        "PDF",
        "PDF_2.3x7.5",
        "PDF_4x6",
        "PDF_4x8",
        "PDF_Letter",
        "ZPLII"
      ]
    },
    "metadata": {
      "type": "string"
    },
    "async": {
      "type": "boolean"
    }
  }
}