Ordoro · Schema

Easypost POST Rate Request Schema

Order ManagementInventory ManagementShippingDropshippingEcommerceMulti-ChannelFulfillmentLogistics

Properties

Name Type Description
box_shape string
customs_info array
delivery_confirmation string
insurance_type string
insured_value number
notify_bill_to boolean
notify_ship_to boolean
packages array
reason_for_export string
reference_number string Package level reference, not always necessarily a number
ship_date string
ship_from object The ship_from address is used as the originating address of the rate and label request.
ship_to object The to address is used as the destination address of a return order rate and label request.
shipper_id integer
reference_id string Identifier for a Return Order
shipping_method string ignored for rate requests
View JSON Schema on GitHub

JSON Schema

ordoro-post_easypost_rate-schema.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ordoro/refs/heads/main/json-schema/ordoro-post_easypost_rate-schema.json",
  "title": "Easypost POST Rate Request Schema",
  "additionalProperties": true,
  "properties": {
    "box_shape": {
      "type": "string"
    },
    "customs_info": {
      "items": {
        "$ref": "#/components/schemas/customs_line"
      },
      "type": "array"
    },
    "delivery_confirmation": {
      "type": "string"
    },
    "insurance_type": {
      "type": "string"
    },
    "insured_value": {
      "type": "number"
    },
    "notify_bill_to": {
      "default": false,
      "type": "boolean"
    },
    "notify_ship_to": {
      "default": false,
      "type": "boolean"
    },
    "packages": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "additional_handling": {
            "type": "boolean"
          },
          "box_shape": {
            "type": "string"
          },
          "height": {
            "description": "Height in inches",
            "type": "number"
          },
          "length": {
            "description": "Length in inches",
            "type": "number"
          },
          "reference_number": {
            "description": "Package level reference, not always necessarily a number",
            "type": "string"
          },
          "reference": {
            "description": "Package level reference, not always necessarily a number",
            "type": "string"
          },
          "weight": {
            "description": "weight of the package in ounces",
            "type": "number"
          },
          "width": {
            "description": "Width in inches",
            "type": "number"
          }
        },
        "type": "object"
      },
      "maxItems": 200,
      "type": "array"
    },
    "reason_for_export": {
      "type": "string"
    },
    "reference_number": {
      "description": "Package level reference, not always necessarily a number",
      "type": "string"
    },
    "ship_date": {
      "type": "string"
    },
    "ship_from": {
      "description": "The ship_from address is used as the originating address of the rate and label request.",
      "$ref": "#/components/schemas/v1_address"
    },
    "ship_to": {
      "description": "The to address is used as the destination address of a return order rate and label request.",
      "$ref": "#/components/schemas/v1_address"
    },
    "shipper_id": {
      "type": "integer"
    },
    "reference_id": {
      "description": "Identifier for a Return Order",
      "type": "string"
    },
    "shipping_method": {
      "description": "ignored for rate requests",
      "type": "string"
    }
  },
  "required": [
    "shipper_id",
    "packages"
  ],
  "type": "object"
}