Shippo · Schema

CarrierAccount

EcommerceLabelsLogisticsReturnsShippingTracking

Properties

Name	Type	Description
object_id	string
carrier	string	Carrier name (e.g., usps, fedex, ups)
account_id	string	Carrier account number
active	boolean	Whether the carrier account is active
test	boolean	Whether this is a test account
parameters	object	Carrier-specific account parameters
object_created	string
object_updated	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CarrierAccount",
  "title": "CarrierAccount",
  "type": "object",
  "properties": {
    "object_id": {
      "type": "string"
    },
    "carrier": {
      "type": "string",
      "description": "Carrier name (e.g., usps, fedex, ups)"
    },
    "account_id": {
      "type": "string",
      "description": "Carrier account number"
    },
    "active": {
      "type": "boolean",
      "description": "Whether the carrier account is active"
    },
    "test": {
      "type": "boolean",
      "description": "Whether this is a test account"
    },
    "parameters": {
      "type": "object",
      "description": "Carrier-specific account parameters"
    },
    "object_created": {
      "type": "string",
      "format": "date-time"
    },
    "object_updated": {
      "type": "string",
      "format": "date-time"
    }
  }
}