ShipStation · Schema

Carrier

EcommerceLabelsLogisticsOrder ManagementShippingWarehousing

Properties

Name	Type	Description
name	string	Carrier name
code	string	Carrier code
accountNumber	string
requiresFundedAccount	boolean
balance	number
nickname	string
shippingProviderId	integer
primary	boolean

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Carrier",
  "title": "Carrier",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Carrier name"
    },
    "code": {
      "type": "string",
      "description": "Carrier code"
    },
    "accountNumber": {
      "type": "string"
    },
    "requiresFundedAccount": {
      "type": "boolean"
    },
    "balance": {
      "type": "number"
    },
    "nickname": {
      "type": "string"
    },
    "shippingProviderId": {
      "type": "integer"
    },
    "primary": {
      "type": "boolean"
    }
  }
}