{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/artashippinginc/main/json-schema/artashippinginc-request-schema.json",
  "title": "Request",
  "x-generated": "2026-09-26",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/arta-openapi.json#/components/schemas/Request",
  "properties": {
    "additional_services": {
      "description": "Any desired services, such as unpacking, installation, etc. can be sent through in the request and will be treated as if that requested service is required. Requested services may disqualify certain segments of shipping services offered by Arta depending on location and object details.",
      "items": {
        "description": "The id of a service.",
        "type": "string",
        "x-struct": null,
        "x-validate": null
      },
      "type": "array",
      "x-struct": null,
      "x-validate": null
    },
    "bookable": {
      "properties": {
        "missing": {
          "description": "A list of fields required for the request to be bookable",
          "items": {
            "type": "string",
            "x-struct": null,
            "x-validate": null
          },
          "type": "array",
          "x-struct": null,
          "x-validate": null
        },
        "ready": {
          "description": "Returns true if the quotes in this request may be booked",
          "type": "boolean",
          "x-struct": null,
          "x-validate": null
        }
      },
      "type": "object",
      "x-struct": null,
      "x-validate": null
    },
    "created_at": {
      "description": "A NaiveDatetime-formatted timestamp describing when the resource was created with microsecond precision",
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "currency": {
      "default": "USD",
      "description": "ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint",
      "maxLength": 3,
      "minLength": 3,
      "pattern": "^[A-Z]{3}$",
      "title": "Currency",
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "customs_end_use": {
      "description": "The intended end use of the items being shipped for customs purposes",
      "enum": [
        "for_resale",
        "not_for_resale"
      ],
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "customs_process": {
      "description": "The customs process for the shipment. \"ddu\" (Delivery Duties Unpaid) means the receiver is responsible for paying duties and taxes. \"ddp\" (Delivery Duties Paid) means the sender prepays duties and taxes. \"ddp_optional\" means the receiver will decide whether to pay estimated duties, fees, and taxes prior to fulfillment",
      "enum": [
        "ddu",
        "ddp",
        "ddp_optional"
      ],
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "destination": {
      "properties": {
        "access_restrictions": {
          "deprecated": true,
          "items": {
            "description": "Id of location restriction type",
            "type": "string",
            "x-struct": null,
            "x-validate": null
          },
          "type": "array",
          "x-struct": null,
          "x-validate": null
        },
        "address_line_1": {
          "description": "First line of address",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "address_line_2": {
          "description": "Second line of address",
          "type": [
            "string",
            "null"
          ],
          "x-struct": null,
          "x-validate": null
        },
        "address_line_3": {
          "description": "Third line of address",
          "type": [
            "string",
            "null"
          ],
          "x-struct": null,
          "x-validate": null
        },
        "city": {
          "description": "City",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "contacts": {
          "description": "A list of contacts at the location",
          "items": {
            "properties": {
              "email_address": {
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "name": {
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "phone_number": {
                "type": "string",
                "x-struct": null,
                "x-validate": null
              }
            },
            "required": [
              "name"
            ],
            "type": "object",
            "x-struct": null,
            "x-validate": null
          },
          "type": "array",
          "x-struct": null,
          "x-validate": null
        },
        "country": {
          "description": "The ISO 3166-1 alpha-2 country code of the current or last known location if available",
          "maxLength": 2,
          "minLength": 2,
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "postal_code": {
          "description": "The postal code",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "region": {
          "description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "title": {
          "description": "The title or name of the location",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        }
      },
      "required": [
        "country"
      ],
      "title": "Location",
      "type": "object",
      "x-struct": "Elixir.DocsWeb.Schemas.Response.Location",
      "x-validate": null
    },
    "disqualifications": {
      "description": "The list of reasons for which particular quote types were disqulified",
      "items": {
        "description": "The disqualifcation reason",
        "properties": {
          "quote_types": {
            "description": "The list of quote types disqualified with this reason",
            "items": {
              "description": "The id of a quote type",
              "type": "string",
              "x-struct": null,
              "x-validate": null
            },
            "type": "array",
            "x-struct": null,
            "x-validate": null
          },
          "reason": {
            "description": "A brief explanation of the disqualification",
            "type": "string",
            "x-struct": null,
            "x-validate": null
          },
          "reason_code": {
            "description": "An ID for the disqualification",
            "type": "string",
            "x-struct": null,
            "x-validate": null
          }
        },
        "type": "object",
        "x-struct": null,
        "x-validate": null
      },
      "type": "array",
      "x-struct": null,
      "x-validate": null
    },
    "hosted_session_id": {
      "description": "The ID of the HostedSession through which this shipment was created",
      "type": [
        "integer",
        "null"
      ],
      "x-struct": null,
      "x-validate": null
    },
    "id": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "insurance": {
      "description": "The id of an insurance type. If requesting Arta insurance, object values must be provided.",
      "type": [
        "string",
        "null"
      ],
      "x-struct": null,
      "x-validate": null
    },
    "internal_reference": {
      "description": "This field can be used to pass through any data about the request you may want returned unaltered for your own later usage",
      "maxLength": 255,
      "type": [
        "string",
        "null"
      ],
      "x-struct": null,
      "x-validate": null
    },
    "log_request_id": {
      "description": "The request ID for the API call that created the resource. This request ID maps to the Log resource's \"request_id\" field",
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "object_count": {
      "description": "The count of objects included in the initial request payload",
      "type": "number",
      "x-struct": null,
      "x-validate": null
    },
    "objects": {
      "description": "A list of objects to be shipped",
      "items": {
        "$ref": "#/$defs/Object"
      },
      "type": "array",
      "x-struct": null,
      "x-validate": null
    },
    "origin": {
      "properties": {
        "access_restrictions": {
          "deprecated": true,
          "items": {
            "description": "Id of location restriction type",
            "type": "string",
            "x-struct": null,
            "x-validate": null
          },
          "type": "array",
          "x-struct": null,
          "x-validate": null
        },
        "address_line_1": {
          "description": "First line of address",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "address_line_2": {
          "description": "Second line of address",
          "type": [
            "string",
            "null"
          ],
          "x-struct": null,
          "x-validate": null
        },
        "address_line_3": {
          "description": "Third line of address",
          "type": [
            "string",
            "null"
          ],
          "x-struct": null,
          "x-validate": null
        },
        "city": {
          "description": "City",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "contacts": {
          "description": "A list of contacts at the location",
          "items": {
            "properties": {
              "email_address": {
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "name": {
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "phone_number": {
                "type": "string",
                "x-struct": null,
                "x-validate": null
              }
            },
            "required": [
              "name"
            ],
            "type": "object",
            "x-struct": null,
            "x-validate": null
          },
          "type": "array",
          "x-struct": null,
          "x-validate": null
        },
        "country": {
          "description": "The ISO 3166-1 alpha-2 country code of the current or last known location if available",
          "maxLength": 2,
          "minLength": 2,
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "postal_code": {
          "description": "The postal code",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "region": {
          "description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "title": {
          "description": "The title or name of the location",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        }
      },
      "required": [
        "country"
      ],
      "title": "Location",
      "type": "object",
      "x-struct": "Elixir.DocsWeb.Schemas.Response.Location",
      "x-validate": null
    },
    "payment_process": {
      "description": "The primary method by which payment to Arta will be handled for any shipment booked from this request",
      "enum": [
        "checkout",
        "invoicing"
      ],
      "maxLength": 255,
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "preferred_parcel_transport_services": {
      "description": "Optionally instruct the Arta API to filter Parcel and Self Ship quotes for specific transport services. For example, if you would prefer to only return `ground` quotes, you can set this field to `[\"ground\"]` The list of valid transport service IDs is available at the /metadata/parcel_transport_services endpoint.",
      "items": {
        "type": "string",
        "x-struct": null,
        "x-validate": null
      },
      "type": [
        "array",
        "null"
      ],
      "x-struct": null,
      "x-validate": null
    },
    "preferred_quote_types": {
      "description": "An optional field presenting the list of quote types the caller instructed Arta to return as part of the quote request",
      "items": {
        "type": "string",
        "x-struct": null,
        "x-validate": null
      },
      "type": "array",
      "x-struct": null,
      "x-validate": null
    },
    "public_reference": {
      "description": "A client defined name for the resource. The value provided for the public_reference field may appear in notification emails and public web pages",
      "maxLength": 255,
      "type": [
        "string",
        "null"
      ],
      "x-struct": null,
      "x-validate": null
    },
    "quote_types": {
      "description": "The list of quote types returned as part of the quotes in this quote request",
      "items": {
        "description": "The id of a quote type",
        "type": "string",
        "x-struct": null,
        "x-validate": null
      },
      "type": "array",
      "x-struct": null,
      "x-validate": null
    },
    "quotes": {
      "description": "The list of quotes returned for the request",
      "items": {
        "properties": {
          "id": {
            "type": "integer",
            "x-struct": null,
            "x-validate": null
          },
          "included_insurance_policy": {
            "properties": {
              "amount": {
                "pattern": "^(0|([1-9]+[0-9]*))(\\.[0-9]{1,2})?$",
                "title": "MonetaryAmount",
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "amount_currency": {
                "default": "USD",
                "description": "ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint",
                "maxLength": 3,
                "minLength": 3,
                "pattern": "^[A-Z]{3}$",
                "title": "Currency",
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "id": {
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "insured_value": {
                "pattern": "^(0|([1-9]+[0-9]*))(\\.[0-9]{1,2})?$",
                "title": "MonetaryAmount",
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "insured_value_currency": {
                "default": "USD",
                "description": "ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint",
                "maxLength": 3,
                "minLength": 3,
                "pattern": "^[A-Z]{3}$",
                "title": "Currency",
                "type": "string",
                "x-struct": null,
                "x-validate": null
              }
            },
            "type": [
              "object",
              "null"
            ],
            "x-struct": null,
            "x-validate": null
          },
          "included_services": {
            "items": {
              "properties": {
                "amount": {
                  "pattern": "^(0|([1-9]+[0-9]*))(\\.[0-9]{1,2})?$",
                  "title": "MonetaryAmount",
                  "type": "string",
                  "x-struct": null,
                  "x-validate": null
                },
                "amount_currency": {
                  "default": "USD",
                  "description": "ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint",
                  "maxLength": 3,
                  "minLength": 3,
                  "pattern": "^[A-Z]{3}$",
                  "title": "Currency",
                  "type": "string",
                  "x-struct": null,
                  "x-validate": null
                },
                "included_services": {
                  "items": {
                    "properties": {
                      "name": {
                        "type": "string",
                        "x-struct": null,
                        "x-validate": null
                      },
                      "sub_subtype": {
                        "type": "string",
                        "x-struct": null,
                        "x-validate": null
                      },
                      "subtype": {
                        "type": "string",
                        "x-struct": null,
                        "x-validate": null
                      },
                      "type": {
                        "type": "string",
                        "x-struct": null,
                        "x-validate": null
                      }
                    },
                    "type": "object",
                    "x-struct": null,
                    "x-validate": null
                  },
                  "type": "array",
                  "x-struct": null,
                  "x-validate": null
                },
                "is_requested": {
                  "type": "boolean",
                  "x-struct": null,
                  "x-validate": null
                },
                "is_required": {
                  "type": "boolean",
                  "x-struct": null,
                  "x-validate": null
                },
                "metadata": {
                  "description": "Additional data about the service. For services with a `type` value of `\"transport\"` generated through instant quoting, `metadata` may include `reference_rate.provider` and `reference_rate.service_level` fields that indicate the carrier and mode of transport used to price this service",
                  "type": "object",
                  "x-struct": null,
                  "x-validate": null
                },
                "name": {
                  "type": "string",
                  "x-struct": null,
                  "x-validate": null
                },
                "sub_subtype": {
                  "type": "string",
                  "x-struct": null,
                  "x-validate": null
                },
                "subtype": {
                  "type": "string",
                  "x-struct": null,
                  "x-validate": null
                },
                "type": {
                  "type": "string",
                  "x-struct": null,
                  "x-validate": null
                }
              },
              "type": "object",
              "x-struct": null,
              "x-validate": null
            },
            "type": "array",
            "x-struct": null,
            "x-validate": null
          },
          "optional_services": {
            "items": {
              "properties": {
                "amount": {
                  "pattern": "^(0|([1-9]+[0-9]*))(\\.[0-9]{1,2})?$",
                  "title": "MonetaryAmount",
                  "type": "string",
                  "x-struct": null,
                  "x-validate": null
                },
                "amount_currency": {
                  "default": "USD",
                  "description": "ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint",
                  "maxLength": 3,
                  "minLength": 3,
                  "pattern": "^[A-Z]{3}$",
                  "title": "Currency",
                  "type": "string",
                  "x-struct": null,
                  "x-validate": null
                },
                "included_services": {
                  "items": {
                    "properties": {
                      "name": {
                        "type": "string",
                        "x-struct": null,
                        "x-validate": null
                      },
                      "sub_subtype": {
                        "type": "string",
                        "x-struct": null,
                        "x-validate": null
                      },
                      "subtype": {
                        "type": "string",
                        "x-struct": null,
                        "x-validate": null
                      },
                      "type": {
                        "type": "string",
                        "x-struct": null,
                        "x-validate": null
                      }
                    },
                    "type": "object",
                    "x-struct": null,
                    "x-validate": null
                  },
                  "type": "array",
                  "x-struct": null,
                  "x-validate": null
                },
                "name": {
                  "type": "string",
                  "x-struct": null,
                  "x-validate": null
                },
                "sub_subtype": {
                  "type": "string",
                  "x-struct": null,
                  "x-validate": null
                },
                "subtype": {
                  "type": "string",
                  "x-struct": null,
                  "x-validate": null
                },
                "type": {
                  "type": "string",
                  "x-struct": null,
                  "x-validate": null
                }
              },
              "type": "object",
              "x-struct": null,
              "x-validate": null
            },
            "type": "array",
            "x-struct": null,
            "x-validate": null
          },
          "quote_type": {
            "type": "string",
            "x-struct": null,
            "x-validate": null
          },
          "status": {
            "type": "string",
            "x-struct": null,
            "x-validate": null
          },
          "tags": {
            "description": "A list of tags associated with this request",
            "items": {
              "$ref": "#/$defs/Tag"
            },
            "type": "array",
            "x-struct": null,
            "x-validate": null
          },
          "total": {
            "pattern": "^(0|([1-9]+[0-9]*))(\\.[0-9]{1,2})?$",
            "title": "MonetaryAmount",
            "type": "string",
            "x-struct": null,
            "x-validate": null
          },
          "total_currency": {
            "default": "USD",
            "description": "ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint",
            "maxLength": 3,
            "minLength": 3,
            "pattern": "^[A-Z]{3}$",
            "title": "Currency",
            "type": "string",
            "x-struct": null,
            "x-validate": null
          }
        },
        "type": "object",
        "x-struct": null,
        "x-validate": null
      },
      "type": "array",
      "x-struct": null,
      "x-validate": null
    },
    "quoting_strategy": {
      "description": "The quoting strategy used when creating quotes for this request. Determines whether the API returns a single best-rate option per transport speed or multiple carrier options for comparison. If not specified, the default strategy (“best_rate”) will be applied.",
      "enum": [
        "best_rate",
        "compare_carriers"
      ],
      "maxLength": 255,
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "shipping_notes": {
      "description": "This field can be used to pass through any notes to Arta that a customer might want to provide about the request",
      "type": [
        "string",
        "null"
      ],
      "x-struct": null,
      "x-validate": null
    },
    "shortcode": {
      "description": "A brief and unique string identifier for the resource",
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "status": {
      "enum": [
        "quoted",
        "in_progress",
        "cancelled",
        "closed",
        "disqualified",
        "expired",
        "pending"
      ],
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "tags": {
      "description": "A list of tags associated with this request",
      "items": {
        "$ref": "#/$defs/Tag"
      },
      "type": "array",
      "x-struct": null,
      "x-validate": null
    },
    "updated_at": {
      "description": "A NaiveDatetime-formatted timestamp describing when the resource was last updated with microsecond precision",
      "type": "string",
      "x-struct": null,
      "x-validate": null
    }
  },
  "type": "object",
  "x-struct": "Elixir.DocsWeb.Schemas.Response.Request",
  "x-validate": null,
  "$defs": {
    "Currency": {
      "default": "USD",
      "description": "ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint",
      "maxLength": 3,
      "minLength": 3,
      "pattern": "^[A-Z]{3}$",
      "title": "Currency",
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "MonetaryAmount": {
      "pattern": "^(0|([1-9]+[0-9]*))(\\.[0-9]{1,2})?$",
      "title": "MonetaryAmount",
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "Object": {
      "properties": {
        "components": {
          "description": "A list of components in the object. Should be used only with a `prepacked_box` object subtype.\n\nWhen components are present, the object value must equal the sum of component values.",
          "items": {
            "properties": {
              "customs": {
                "properties": {
                  "country_of_origin": {
                    "description": "The ISO 3166-1 alpha-2 country code where the object was made or manufactured",
                    "maxLength": 2,
                    "minLength": 2,
                    "type": "string",
                    "x-struct": null,
                    "x-validate": null
                  },
                  "hs_code": {
                    "description": "The Harmonized System code for the object. This is a 6-10 digit code used to classify traded products",
                    "type": "string",
                    "x-struct": null,
                    "x-validate": null
                  },
                  "medium": {
                    "description": "The medium of the object. This is a description of the material or materials used to create the object",
                    "type": "string",
                    "x-struct": null,
                    "x-validate": null
                  },
                  "temporary_admission": {
                    "description": "Select true if the goods are currently in the country under a temporary admission declaration",
                    "type": "boolean",
                    "x-struct": null,
                    "x-validate": null
                  }
                },
                "type": "object",
                "x-struct": null,
                "x-validate": null
              },
              "details": {
                "properties": {
                  "creation_date": {
                    "description": "Details about the timing in which an object was created",
                    "type": "string",
                    "x-struct": null,
                    "x-validate": null
                  },
                  "creator": {
                    "description": "The creator of the object",
                    "type": "string",
                    "x-struct": null,
                    "x-validate": null
                  },
                  "notes": {
                    "description": "Any notes about the item",
                    "type": "string",
                    "x-struct": null,
                    "x-validate": null
                  },
                  "title": {
                    "description": "The object title",
                    "type": "string",
                    "x-struct": null,
                    "x-validate": null
                  }
                },
                "type": "object",
                "x-struct": null,
                "x-validate": null
              },
              "id": {
                "description": "The id of the component in UUID format",
                "format": "uuid",
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "internal_reference": {
                "description": "This field can be used to pass through any data that you may want returned unaltered for your own later usage",
                "maxLength": 255,
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "public_reference": {
                "description": "A client defined name for the object. The value provided for public_reference may be presented in notification emails and on shipment detail pages",
                "maxLength": 255,
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "type": {
                "description": "The object component type ID. Options are defined in the Object Component types metadata endpoint",
                "pattern": "^[0-9a-z_]{1,56}$",
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "value": {
                "$ref": "#/$defs/MonetaryAmount"
              },
              "value_currency": {
                "$ref": "#/$defs/Currency"
              }
            },
            "type": "object",
            "x-struct": null,
            "x-validate": null
          },
          "type": "array",
          "x-struct": null,
          "x-validate": null
        },
        "current_packing": {
          "description": "A list of packing subtype IDs describing how the item is currently packed",
          "items": {
            "type": "string",
            "x-struct": null,
            "x-validate": null
          },
          "type": "array",
          "x-struct": null,
          "x-validate": null
        },
        "customs": {
          "properties": {
            "country_of_origin": {
              "description": "The ISO 3166-1 alpha-2 country code where the object was made or manufactured",
              "maxLength": 2,
              "minLength": 2,
              "type": "string",
              "x-struct": null,
              "x-validate": null
            },
            "hs_code": {
              "description": "The Harmonized System code for the object. This is a 6-10 digit code used to classify traded products",
              "type": "string",
              "x-struct": null,
              "x-validate": null
            },
            "medium": {
              "description": "The medium of the object. This is a description of the material or materials used to create the object",
              "type": "string",
              "x-struct": null,
              "x-validate": null
            },
            "temporary_admission": {
              "description": "Select true if the goods are currently in the country under a temporary admission declaration",
              "type": "boolean",
              "x-struct": null,
              "x-validate": null
            }
          },
          "type": "object",
          "x-struct": null,
          "x-validate": null
        },
        "depth": {
          "description": "The depth of the object",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "details": {
          "properties": {
            "creation_date": {
              "description": "Details about the timing in which an object was created",
              "type": "string",
              "x-struct": null,
              "x-validate": null
            },
            "creator": {
              "description": "The creator of the object",
              "type": "string",
              "x-struct": null,
              "x-validate": null
            },
            "is_cites": {
              "default": false,
              "description": "Set to true if the object is governed by the Convention on International Trade in Endangered Species of Wild Fauna and Flora",
              "type": "boolean",
              "x-struct": null,
              "x-validate": null
            },
            "is_fragile": {
              "default": false,
              "description": "Set this flag to true is the item is fragile. This may effect packing and handling costs",
              "type": "boolean",
              "x-struct": null,
              "x-validate": null
            },
            "materials": {
              "deprecated": true,
              "description": "A list of IDs describing the types of materials used",
              "items": {
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "type": "array",
              "x-struct": null,
              "x-validate": null
            },
            "notes": {
              "description": "Any notes about the item",
              "type": "string",
              "x-struct": null,
              "x-validate": null
            },
            "title": {
              "description": "The object title",
              "type": "string",
              "x-struct": null,
              "x-validate": null
            }
          },
          "type": "object",
          "x-struct": null,
          "x-validate": null
        },
        "height": {
          "description": "The height of the object",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "id": {
          "format": "int64",
          "type": "integer",
          "x-struct": null,
          "x-validate": null
        },
        "images": {
          "description": "A list image urls of the object",
          "items": {
            "format": "uri",
            "type": "string",
            "x-struct": null,
            "x-validate": null
          },
          "type": "array",
          "x-struct": null,
          "x-validate": null
        },
        "internal_reference": {
          "description": "This field can be used to pass through any data that you may want returned unaltered for your own later usage",
          "maxLength": 255,
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "public_reference": {
          "description": "A client defined name for the object. The value provided for public_reference may be presented in notification emails and on shipment detail pages",
          "maxLength": 255,
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "subtype": {
          "description": "The object subtype ID. Options are defined in the Object types metadata endpoint",
          "pattern": "^[0-9a-z_]{1,56}$",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "type": {
          "description": "The object type id",
          "pattern": "^[0-9a-z_]{1,56}$",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "unit_of_measurement": {
          "enum": [
            "in",
            "cm"
          ],
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "value": {
          "$ref": "#/$defs/MonetaryAmount"
        },
        "value_currency": {
          "$ref": "#/$defs/Currency"
        },
        "weight": {
          "description": "The weight of the object",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "weight_unit": {
          "description": "The unit of the object",
          "enum": [
            "lb",
            "kg"
          ],
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "width": {
          "description": "The width of the object",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        }
      },
      "title": "Object",
      "type": "object",
      "x-struct": "Elixir.DocsWeb.Schemas.Response.Object",
      "x-validate": null
    },
    "Tag": {
      "properties": {
        "color": {
          "description": "The hexadecimal color code for the tag, without the leading `#`.",
          "maxLength": 6,
          "minLength": 6,
          "pattern": "^[0-9A-F]{6}$",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "created_at": {
          "description": "A NaiveDatetime-formatted timestamp describing when the resource was created with microsecond precision",
          "format": "date-time",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "created_by": {
          "description": "The user ID associated with the user who created the tag when applicable.",
          "format": "int64",
          "type": [
            "integer",
            "null"
          ],
          "x-struct": null,
          "x-validate": null
        },
        "description": {
          "description": "An optional, brief description for this tag.",
          "maxLength": 255,
          "type": [
            "string",
            "null"
          ],
          "x-struct": null,
          "x-validate": null
        },
        "id": {
          "description": "The id of the tag in UUID format",
          "format": "uuid",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "is_active": {
          "description": "Indicates whether or not the tag is active. Inactive tags may not be associated to new resources",
          "type": "boolean",
          "x-struct": null,
          "x-validate": null
        },
        "name": {
          "description": "The name for the tag. It may contain lower case letters, dashes, and alphanumeric characters only. The maximum character count is 50.",
          "maxLength": 50,
          "pattern": "^[a-z0-9-]{1,50}$",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "updated_at": {
          "description": "A NaiveDatetime-formatted timestamp describing when the resource was last updated with microsecond precision",
          "format": "date-time",
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "updated_by": {
          "description": "The user ID associated with the last user to edit the tag when applicable.",
          "format": "int64",
          "type": [
            "integer",
            "null"
          ],
          "x-struct": null,
          "x-validate": null
        }
      },
      "title": "Tag",
      "type": "object",
      "x-struct": "Elixir.DocsWeb.Schemas.Response.Tag",
      "x-validate": null
    }
  }
}