{ "components": { "responses": {}, "schemas": { "MetadataLocationAccessRestriction": { "deprecated": true, "items": { "properties": { "description": { "description": "A long form description", "example": "The location can only be accessed by elevator", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The ID representing the resource", "example": "elevator_only", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "A brief label for the resource", "example": "Only Elevator", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "title": "MetadataLocationAccessRestriction", "type": "array", "x-struct": "Elixir.DocsWeb.Schemas.Response.Metadata.LocationAccessRestriction", "x-validate": null }, "WebhookCreate": { "additionalProperties": false, "properties": { "webhook": { "properties": { "name": { "description": "The name for this Webhook.", "example": "Production webhooks endpoint", "type": "string", "x-struct": null, "x-validate": null }, "url": { "description": "The URL for this Webhook.", "example": "https://notifications.example.com/", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "webhook" ], "title": "WebhookCreate", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.WebhookCreate", "x-validate": null }, "MetadataReferenceRateServiceLevel": { "example": [ { "id": "arta", "name": "Arta" }, { "id": "dhl_express_worldwide", "name": "DHL Express" }, { "id": "fedex_2_day", "name": "FedEx Priority" }, { "id": "fedex_ground", "name": "FedEx Ground" }, { "id": "ups_ground", "name": "UPS Ground" } ], "items": { "properties": { "id": { "description": "The ID representing the service level", "example": "ups_2nd_day_air", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "A brief label for the service level", "example": "UPS 2nd Day Air", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "title": "MetadataReferenceRateServiceLevel", "type": "array", "x-struct": "Elixir.DocsWeb.Schemas.Response.Metadata.ReferenceRateServiceLevel", "x-validate": null }, "MetadataCurrency": { "items": { "properties": { "id": { "description": "The ID representing the resource", "example": "USD", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "A brief label for the currency", "example": "US Dollar", "type": "string", "x-struct": null, "x-validate": null }, "symbol": { "description": "The symbol used to denote that a number is a monetary value in a particular currency", "example": "$", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "title": "MetadataCurrency", "type": "array", "x-struct": "Elixir.DocsWeb.Schemas.Response.Metadata.Currency", "x-validate": null }, "EmailSubscription": { "example": { "created_at": "2020-10-14T15:25:48.298369", "email_address": "notifications@shiparta.com", "email_notification_ids": [ "booking", "complete", "scheduling" ], "id": 6, "name": "Arta Notifications", "updated_at": "2020-10-14T15:25:48.298369" }, "properties": { "created_at": { "type": "string", "x-struct": null, "x-validate": null }, "email_address": { "type": "string", "x-struct": null, "x-validate": null }, "email_notification_ids": { "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "id": { "format": "int64", "type": "integer", "x-struct": null, "x-validate": null }, "name": { "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "type": "string", "x-struct": null, "x-validate": null } }, "title": "EmailSubscription", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.EmailSubscription", "x-validate": null }, "WebhookUpdate": { "additionalProperties": false, "properties": { "webhook": { "properties": { "name": { "description": "The name for this Webhook.", "example": "hello@shiparta.com", "type": "string", "x-struct": null, "x-validate": null }, "url": { "description": "The URL for this Webhook.", "example": "Arta", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "webhook" ], "title": "WebhookUpdate", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.WebhookUpdate", "x-validate": null }, "Webhook": { "example": { "created_at": "2020-10-22T21:12:48.839165", "id": 4, "name": "Notifications Endpoint", "updated_at": "2020-10-22T21:12:48.839165", "url": "https://notifications.example.com/hooks/" }, "properties": { "created_at": { "type": "string", "x-struct": null, "x-validate": null }, "id": { "format": "int64", "type": "integer", "x-struct": null, "x-validate": null }, "name": { "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "type": "string", "x-struct": null, "x-validate": null }, "url": { "type": "string", "x-struct": null, "x-validate": null } }, "title": "Webhook", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.Webhook", "x-validate": null }, "ApiKeyCreate": { "additionalProperties": false, "properties": { "api_key": { "properties": { "is_testing": { "default": false, "description": "Whether this API Key should operate in Live or Test mode.", "example": true, "type": "boolean", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "api_key" ], "title": "ApiKeyCreate", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.ApiKeyCreate", "x-validate": null }, "APIKey": { "properties": { "created_at": { "example": "2021-01-21T17:22:08.818747", "type": "string", "x-struct": null, "x-validate": null }, "id": { "example": 2, "format": "int64", "type": "integer", "x-struct": null, "x-validate": null }, "is_testing": { "default": false, "type": "boolean", "x-struct": null, "x-validate": null }, "token": { "example": "******************eQ0Rqp", "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "example": "2021-01-21T17:22:08.818747", "type": "string", "x-struct": null, "x-validate": null } }, "title": "APIKey", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.APIKey", "x-validate": null }, "WebhookDeliveryListItem": { "properties": { "created_at": { "example": "2021-10-27T16:48:38.657228", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The string ID for this webhook delivery resource", "example": "5b6e1621-454f-4f18-aecf-87192406effe", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "next_retry": { "description": "The UTC timestamp describing when a follow up webhook delivery event will be attempted if this one has failed", "nullable": true, "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "resource_id": { "description": "The ID of the resource that triggered the webhook event", "example": "9c67b26c-6b5d-4e19-a703-f7356f82d7e0", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "resource_type": { "description": "The type of resource that triggered the webhook event", "enum": [ "ping", "request", "shipment" ], "example": "request", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "response_status_code": { "example": 202, "readOnly": true, "type": "number", "x-struct": null, "x-validate": null }, "status": { "description": "The status of the webhook delivery event", "enum": [ "delivered", "failed" ], "example": "delivered", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "The type of webhook delivery sent to your endpoint", "enum": [ "ping", "request.created", "request.shared", "request.status.updated", "request.updated", "shipment.created", "shipment.eei_form_status.updated", "shipment.exceptions.updated", "shipment.schedule.updated", "shipment.status.updated", "shipment.tracking.updated", "shipment.updated", "shipment_exception.created", "shipment_exception.status.updated" ], "example": "ping", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "webhook_id": { "description": "The ID belonging to your webhook endpoint in Arta's system", "example": 432672, "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "webhook_url": { "description": "The URL belonging to your webhook endpoint in Arta's system at the time Arta attempted delivery of the webhook event", "example": "https://hooks.mydomain.xyz/arta", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null } }, "title": "WebhookDeliveryListItem", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.WebhookDeliveryListItem", "x-validate": null }, "SelfShipCollectionAvailabilityCheckCreate": { "additionalProperties": false, "properties": { "self_ship_collection_availability_check": { "properties": { "collection_date": { "description": "Date to check availability for in ISO 8601 format (`YYYY-MM-DD`)", "example": "2026-03-06", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "location": { "description": "Pickup location to check availability for", "properties": { "address_line_1": { "description": "Street address", "example": "123 Main St", "minLength": 1, "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "Additional address info", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "City", "example": "New York", "minLength": 1, "type": "string", "x-struct": null, "x-validate": null }, "close_time": { "description": "Location closing time in ISO 8601 format (`HH:MM:SS`)", "example": "17:00:00", "type": "string", "x-struct": null, "x-validate": null }, "country": { "description": "Two-letter country code. Currently `US` and `GB` are supported.", "example": "US", "maxLength": 2, "minLength": 2, "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "Postal code", "example": "10001", "minLength": 1, "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "State or province code", "example": "NY", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "address_line_1", "city", "country", "postal_code", "close_time" ], "type": "object", "x-struct": null, "x-validate": null }, "service": { "description": "Carrier service to check availability for", "properties": { "carrier": { "description": "Carrier identifier", "enum": [ "fedex" ], "type": "string", "x-struct": null, "x-validate": null }, "code": { "description": "Service level code", "enum": [ "ground", "express" ], "type": "string", "x-struct": null, "x-validate": null }, "route": { "description": "Route type", "enum": [ "domestic", "international" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "carrier", "code", "route" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "location", "service", "collection_date" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "self_ship_collection_availability_check" ], "title": "SelfShipCollectionAvailabilityCheckCreate", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.SelfShipCollectionAvailabilityCheckCreate", "x-validate": null }, "HostedSessionCreate": { "oneOf": [ { "additionalProperties": false, "description": "Create hosted booking session", "properties": { "hosted_session": { "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, meaning this may disqualify certain segments of shipping services we offer.", "items": { "description": "The id of a service.", "example": "signature_delivery", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "cancel_url": { "description": "The URL the user will be redirected to after a Arta Booking session is cancelled", "example": "http://example.com/cancelled", "type": "string", "x-struct": null, "x-validate": null }, "customs_end_use": { "default": "not_for_resale", "description": "The intended end use of the items being shipped for customs purposes", "enum": [ "for_resale", "not_for_resale" ], "example": "not_for_resale", "type": "string", "x-struct": null, "x-validate": null }, "customs_process": { "default": "ddu", "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" ], "example": "ddu", "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", "example": "87 Richardson St", "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "Second line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "address_line_3": { "description": "Third line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "City", "example": "Brooklyn", "type": "string", "x-struct": null, "x-validate": null }, "contacts": { "description": "A list of contacts at the location", "items": { "properties": { "email_address": { "example": "docs@arta.io", "type": "string", "x-struct": null, "x-validate": null }, "name": { "example": "Contact Name", "type": "string", "x-struct": null, "x-validate": null }, "phone_number": { "example": "646 828 7333", "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", "example": "US", "maxLength": 2, "minLength": 2, "required": true, "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "The postal code", "example": "11211", "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations", "example": "NY", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The title or name of the location", "example": "Gallery", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "insurance": { "description": "The ID of the requested Arta insurance type. Options are defined in the Insurances metadata endpoint", "example": "arta_transit_insurance", "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", "example": "Purchase Order: 2801", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "objects": { "items": { "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", "example": "US", "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", "example": "123456", "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", "example": "oil on canvas", "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", "example": true, "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", "example": "1980", "type": "string", "x-struct": null, "x-validate": null }, "creator": { "description": "The creator of the object", "example": "Bob Smithson", "type": "string", "x-struct": null, "x-validate": null }, "notes": { "description": "Any notes about the item", "example": "Artist signature in the lower left corner", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The object title", "example": "Black Rectangle", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "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", "example": "Accession ID: 823", "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", "example": "Round Smithson work", "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", "example": "painting_framed", "pattern": "^[0-9a-z_]{1,56}$", "type": "string", "x-struct": null, "x-validate": null }, "value": { "$ref": "#/components/schemas/MonetaryAmount" }, "value_currency": { "$ref": "#/components/schemas/Currency" } }, "required": [ "type", "value" ], "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": { "example": "no_packing", "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", "example": "US", "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", "example": "123456", "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", "example": "oil on canvas", "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", "example": true, "type": "boolean", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "depth": { "description": "The depth of the object", "example": "3", "type": "string", "x-struct": null, "x-validate": null }, "details": { "properties": { "creation_date": { "description": "Details about the timing in which an object was created", "example": "1980", "type": "string", "x-struct": null, "x-validate": null }, "creator": { "description": "The creator of the object", "example": "Bob Smithson", "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": { "example": "canvas", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "notes": { "description": "Any notes about the item", "example": "Artist signature in the lower left corner", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The object title", "example": "Black Rectangle", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "height": { "description": "The height of the object", "example": "32", "type": "string", "x-struct": null, "x-validate": null }, "images": { "description": "A list image urls of the object", "items": { "example": "http://example.com/image.jpg", "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", "example": "Accession ID: 823", "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", "example": "Round Smithson work", "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", "example": "painting_unframed", "pattern": "^[0-9a-z_]{1,56}$", "type": "string", "x-struct": null, "x-validate": null }, "unit_of_measurement": { "enum": [ "in", "cm" ], "example": "in", "type": "string", "x-struct": null, "x-validate": null }, "value": { "$ref": "#/components/schemas/MonetaryAmount" }, "value_currency": { "$ref": "#/components/schemas/Currency" }, "weight": { "description": "The weight of the object", "example": "3.0", "type": "string", "x-struct": null, "x-validate": null }, "weight_unit": { "description": "The unit of the object", "enum": [ "lb", "kg" ], "example": "lb", "type": "string", "x-struct": null, "x-validate": null }, "width": { "description": "The width of the object", "example": "15", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "depth", "height", "subtype", "width", "unit_of_measurement", "weight_unit", "value", "value_currency" ], "type": "object", "x-struct": null, "x-validate": null }, "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", "example": "87 Richardson St", "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "Second line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "address_line_3": { "description": "Third line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "City", "example": "Brooklyn", "type": "string", "x-struct": null, "x-validate": null }, "contacts": { "description": "A list of contacts at the location", "items": { "properties": { "email_address": { "example": "docs@arta.io", "type": "string", "x-struct": null, "x-validate": null }, "name": { "example": "Contact Name", "type": "string", "x-struct": null, "x-validate": null }, "phone_number": { "example": "646 828 7333", "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", "example": "US", "maxLength": 2, "minLength": 2, "required": true, "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "The postal code", "example": "11211", "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations", "example": "NY", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The title or name of the location", "example": "Gallery", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "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.", "example": [ "ground" ], "items": { "type": "string", "x-struct": null, "x-validate": null }, "nullable": true, "type": "array", "x-struct": null, "x-validate": null }, "preferred_quote_types": { "description": "Optionally instruct the Arta API to return a subset of quote types for the requests generated through this hosted session. For example if you would prefer to only return Select quotes, you can set this field to `[\"select\"]` The list valid quote type IDs are available at the /metadata/quotes endpoint.", "example": [ "parcel" ], "items": { "type": "string", "x-struct": null, "x-validate": null }, "nullable": true, "type": "array", "x-struct": null, "x-validate": null }, "public_instructions_booking_review": { "description": "A client defined multi-line block of text presented to users in the quote review modal window prior to booking a shipment for booking, shared request, and inbound booking sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "type": "string", "x-struct": null, "x-validate": null }, "public_instructions_confirmation": { "description": "A client defined multi-line block of text presented to users on the post-shipment booking confirmation view for booking, shared request, and inbound booking hosted sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "type": "string", "x-struct": null, "x-validate": null }, "public_instructions_location_quotes": { "description": "A client defined multi-line block of text presented to users on the location and quote selection view for booking, shared request, and inbound booking hosted sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "type": "string", "x-struct": null, "x-validate": null }, "public_instructions_payment": { "description": "A client defined multi-line block of text presented to users on the post-shipment booking payment view when required for booking, shared request, and inbound booking hosted sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "type": "string", "x-struct": null, "x-validate": null }, "public_reference": { "description": "A client defined name for the request. The value provided for the public_reference field may appear in notification emails and shipment detail pages", "example": "Order #1437", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "quoting_strategy": { "default": "best_rate", "description": "The quoting strategy used when creating quote requests for this booking session. Determines whether the API returns a single best-rate option per transport speed or multiple carrier options for comparison", "enum": [ "best_rate", "compare_carriers" ], "example": "best_rate", "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", "example": "New customer", "type": "string", "x-struct": null, "x-validate": null }, "success_url": { "description": "The URL the user will be redirected to after a Arta Booking session is completed", "example": "http://example.com/success", "type": "string", "x-struct": null, "x-validate": null }, "tags": { "description": "A list of tags to associate with this hosted session", "items": { "description": "The name of an active tag belonging to your organization.", "example": "spring-jewelry-sale", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "type": { "default": "booking", "description": "The type of the hosted session", "enum": [ "booking" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "objects", "origin" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "hosted_session" ], "title": "BookingSession", "type": "object", "x-struct": null, "x-validate": null }, { "additionalProperties": false, "description": "Create hosted booking session from an existing quote request", "properties": { "hosted_session": { "properties": { "request_id": { "description": "The ID of an existing Request to be shared.", "required": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "hosted_session" ], "title": "ShareRequest", "type": "object", "x-struct": null, "x-validate": null }, { "additionalProperties": false, "description": "Create hosted inbound booking session", "properties": { "hosted_session": { "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, meaning this may disqualify certain segments of shipping services we offer.", "items": { "description": "The id of a service.", "example": "signature_delivery", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "can_user_confirm_object_dimensions": { "default": false, "description": "Determines whether your customer can verify and update object dimension information when completing an inbound booking session.", "type": "boolean", "x-struct": null, "x-validate": null }, "cancel_url": { "description": "The URL the user will be redirected to after a Arta Booking session is cancelled", "example": "http://example.com/cancelled", "type": "string", "x-struct": null, "x-validate": null }, "customs_end_use": { "default": "not_for_resale", "description": "The intended end use of the items being shipped for customs purposes", "enum": [ "for_resale", "not_for_resale" ], "example": "not_for_resale", "type": "string", "x-struct": null, "x-validate": null }, "customs_process": { "default": "ddu", "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" ], "example": "ddu", "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", "example": "87 Richardson St", "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "Second line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "address_line_3": { "description": "Third line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "City", "example": "Brooklyn", "type": "string", "x-struct": null, "x-validate": null }, "contacts": { "description": "A list of contacts at the location", "items": { "properties": { "email_address": { "example": "docs@arta.io", "type": "string", "x-struct": null, "x-validate": null }, "name": { "example": "Contact Name", "type": "string", "x-struct": null, "x-validate": null }, "phone_number": { "example": "646 828 7333", "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", "example": "US", "maxLength": 2, "minLength": 2, "required": true, "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "The postal code", "example": "11211", "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations", "example": "NY", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The title or name of the location", "example": "Gallery", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "insurance": { "description": "The ID of the requested Arta insurance type. Options are defined in the Insurances metadata endpoint", "example": "arta_transit_insurance", "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", "example": "Purchase Order: 2801", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "objects": { "items": { "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", "example": "US", "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", "example": "123456", "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", "example": "oil on canvas", "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", "example": true, "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", "example": "1980", "type": "string", "x-struct": null, "x-validate": null }, "creator": { "description": "The creator of the object", "example": "Bob Smithson", "type": "string", "x-struct": null, "x-validate": null }, "notes": { "description": "Any notes about the item", "example": "Artist signature in the lower left corner", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The object title", "example": "Black Rectangle", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "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", "example": "Accession ID: 823", "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", "example": "Round Smithson work", "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", "example": "painting_framed", "pattern": "^[0-9a-z_]{1,56}$", "type": "string", "x-struct": null, "x-validate": null }, "value": { "$ref": "#/components/schemas/MonetaryAmount" }, "value_currency": { "$ref": "#/components/schemas/Currency" } }, "required": [ "type", "value" ], "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": { "example": "no_packing", "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", "example": "US", "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", "example": "123456", "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", "example": "oil on canvas", "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", "example": true, "type": "boolean", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "depth": { "description": "The depth of the object", "example": "3", "type": "string", "x-struct": null, "x-validate": null }, "details": { "properties": { "creation_date": { "description": "Details about the timing in which an object was created", "example": "1980", "type": "string", "x-struct": null, "x-validate": null }, "creator": { "description": "The creator of the object", "example": "Bob Smithson", "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": { "example": "canvas", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "notes": { "description": "Any notes about the item", "example": "Artist signature in the lower left corner", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The object title", "example": "Black Rectangle", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "height": { "description": "The height of the object", "example": "32", "type": "string", "x-struct": null, "x-validate": null }, "images": { "description": "A list image urls of the object", "items": { "example": "http://example.com/image.jpg", "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", "example": "Accession ID: 823", "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", "example": "Round Smithson work", "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", "example": "painting_unframed", "pattern": "^[0-9a-z_]{1,56}$", "type": "string", "x-struct": null, "x-validate": null }, "unit_of_measurement": { "enum": [ "in", "cm" ], "example": "in", "type": "string", "x-struct": null, "x-validate": null }, "value": { "$ref": "#/components/schemas/MonetaryAmount" }, "value_currency": { "$ref": "#/components/schemas/Currency" }, "weight": { "description": "The weight of the object", "example": "3.0", "type": "string", "x-struct": null, "x-validate": null }, "weight_unit": { "description": "The unit of the object", "enum": [ "lb", "kg" ], "example": "lb", "type": "string", "x-struct": null, "x-validate": null }, "width": { "description": "The width of the object", "example": "15", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subtype", "value" ], "type": "object", "x-struct": null, "x-validate": null }, "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", "example": "87 Richardson St", "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "Second line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "address_line_3": { "description": "Third line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "City", "example": "Brooklyn", "type": "string", "x-struct": null, "x-validate": null }, "contacts": { "description": "A list of contacts at the location", "items": { "properties": { "email_address": { "example": "docs@arta.io", "type": "string", "x-struct": null, "x-validate": null }, "name": { "example": "Contact Name", "type": "string", "x-struct": null, "x-validate": null }, "phone_number": { "example": "646 828 7333", "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", "example": "US", "maxLength": 2, "minLength": 2, "required": true, "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "The postal code", "example": "11211", "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations", "example": "NY", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The title or name of the location", "example": "Gallery", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "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.", "example": [ "ground" ], "items": { "type": "string", "x-struct": null, "x-validate": null }, "nullable": true, "type": "array", "x-struct": null, "x-validate": null }, "preferred_quote_types": { "description": "Optionally instruct the Arta API to return a subset of quote types for the requests generated through this hosted session. For example if you would prefer to only return Select quotes, you can set this field to `[\"select\"]` The list valid quote type IDs are available at the /metadata/quotes endpoint.", "example": [ "parcel" ], "items": { "type": "string", "x-struct": null, "x-validate": null }, "nullable": true, "type": "array", "x-struct": null, "x-validate": null }, "public_instructions_booking_review": { "description": "A client defined multi-line block of text presented to users in the quote review modal window prior to booking a shipment for booking, shared request, and inbound booking sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "type": "string", "x-struct": null, "x-validate": null }, "public_instructions_confirmation": { "description": "A client defined multi-line block of text presented to users on the post-shipment booking confirmation view for booking, shared request, and inbound booking hosted sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "type": "string", "x-struct": null, "x-validate": null }, "public_instructions_location_quotes": { "description": "A client defined multi-line block of text presented to users on the location and quote selection view for booking, shared request, and inbound booking hosted sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "type": "string", "x-struct": null, "x-validate": null }, "public_instructions_object_details": { "description": "A client defined multi-line block of text presented to users on the object form in inbound booking hosted sessions.\n\n- Only visible if `can_user_confirm_object_dimensions` is true\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "example": "Please confirm the dimensions of the objects you are shipping.", "type": "string", "x-struct": null, "x-validate": null }, "public_instructions_payment": { "description": "A client defined multi-line block of text presented to users on the post-shipment booking payment view when required for booking, shared request, and inbound booking hosted sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "type": "string", "x-struct": null, "x-validate": null }, "public_reference": { "description": "A client defined name for the request. The value provided for the public_reference field may appear in notification emails and shipment detail pages", "example": "Order #1437", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "quoting_strategy": { "default": "best_rate", "description": "The quoting strategy used when creating quote requests for this booking session. Determines whether the API returns a single best-rate option per transport speed or multiple carrier options for comparison", "enum": [ "best_rate", "compare_carriers" ], "example": "best_rate", "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", "example": "New customer", "type": "string", "x-struct": null, "x-validate": null }, "success_url": { "description": "The URL the user will be redirected to after a Arta Booking session is completed", "example": "http://example.com/success", "type": "string", "x-struct": null, "x-validate": null }, "tags": { "description": "A list of tags to associate with this hosted session", "items": { "description": "The name of an active tag belonging to your organization.", "example": "spring-jewelry-sale", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "type": { "default": "inbound_booking", "description": "The type of the hosted session", "enum": [ "inbound_booking" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "destination", "type" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "hosted_session" ], "title": "InboundBookingSession", "type": "object", "x-struct": null, "x-validate": null } ], "title": "HostedSessionCreate", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.HostedSessionCreate", "x-validate": null }, "Request": { "example": { "additional_services": [], "bookable": { "missing": [], "ready": true }, "created_at": "2021-01-21T17:22:08.818747", "currency": "USD", "customs_end_use": "not_for_resale", "customs_process": "ddu", "destination": { "access_restrictions": [], "address_line_1": "87 Richardson St", "address_line_2": null, "address_line_3": null, "city": "New York", "contacts": [ { "email_address": "al@example.com", "name": "Alfred Barr", "phone_number": "(222) 222-2222" } ], "country": "US", "postal_code": "11249", "region": "NY", "title": "Home" }, "disqualifications": [], "hosted_session_id": 723, "id": "9d8892bc-f4c6-4b45-88e2-0ccd28eb73cc", "insurance": null, "internal_reference": null, "log_request_id": "FpL53jSpPbCUXRAAKPRS", "object_count": 1, "objects": [ { "components": [ { "customs": { "country_of_origin": "US", "hs_code": "123456", "medium": "oil on canvas", "temporary_admission": true }, "details": { "creation_date": "1980", "creator": "Bob Smithson", "notes": "Artist signature in the lower left corner", "title": "Black Rectangle" }, "id": "1f26b6e1-ce25-43a9-b4ea-2ceaac24ec3a", "internal_reference": "Accession ID: 823", "public_reference": "Round Smithson work", "type": "painting_framed", "value": "15000", "value_currency": "USD" } ], "current_packing": [ "cardboard_box" ], "depth": "2", "details": { "creation_date": null, "creator": null, "is_cites": false, "is_fragile": false, "materials": [], "notes": null, "title": null }, "height": "10.5", "id": 1644, "images": [], "internal_reference": null, "public_reference": null, "subtype": "prepacked_box", "type": "client_package", "unit_of_measurement": "in", "value": "15000", "value_currency": "USD", "weight": "3.5", "weight_unit": "lb", "width": "10" }, { "components": [], "current_packing": [], "customs": { "country_of_origin": "US", "hs_code": "123456", "medium": "oil on canvas", "temporary_admission": true }, "depth": "2", "details": { "creation_date": null, "creator": "Robert Irwin", "is_cites": false, "is_fragile": false, "materials": [], "notes": "Artist signature in the lower left corner", "title": "All That Jazz" }, "height": "10.5", "id": 1644, "images": [], "internal_reference": null, "public_reference": null, "subtype": "painting_unframed", "type": "art", "unit_of_measurement": "in", "value": "15000", "value_currency": "USD", "weight": "3.5", "weight_unit": "lb", "width": "10" } ], "origin": { "access_restrictions": [], "address_line_1": "11 W 53rd St", "address_line_2": null, "address_line_3": null, "city": "New York", "contacts": [ { "email_address": "mary@example.com", "name": "Mary Quinn Sullivan", "phone_number": "(333) 333-3333" } ], "country": "US", "postal_code": "10019", "region": "NY", "title": "Warehouse" }, "payment_process": "invoicing", "preferred_parcel_transport_services": [], "preferred_quote_types": [], "public_reference": null, "quote_types": [ "premium", "select", "parcel" ], "quotes": [ { "id": 61, "included_insurance_policy": null, "included_services": [ { "amount": "1", "amount_currency": "USD", "included_services": [], "is_requested": false, "is_required": true, "metadata": { "reference_rate": { "provider": "arta", "service_level": "arta" } }, "name": "Specialized Shuttle", "sub_subtype": "specialized_shuttle", "subtype": "specialized", "type": "transport" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "is_requested": false, "is_required": true, "metadata": {}, "name": "Shadowbox", "sub_subtype": "shadow_box", "subtype": "packing_materials", "type": "packing" } ], "optional_services": [ { "amount": "1", "amount_currency": "USD", "included_services": [ { "name": "Soft Packed Disposal", "sub_subtype": "soft_packed_disposal", "subtype": "debris_disposal", "type": "handling" } ], "name": "Debris Disposal", "sub_subtype": "debris_disposal", "subtype": "debris_disposal", "type": "handling" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "name": "Assembly", "sub_subtype": "assembly", "subtype": "installation", "type": "handling" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "name": "Placement", "sub_subtype": "placement", "subtype": "installation", "type": "handling" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "name": "Installation", "sub_subtype": "installation", "subtype": "installation", "type": "handling" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "name": "Condition Check (destination)", "sub_subtype": "destination_condition_check", "subtype": "condition", "type": "handling" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "name": "Condition Check (origin)", "sub_subtype": "origin_condition_check", "subtype": "condition", "type": "handling" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "name": "Condition Report (destination)", "sub_subtype": "destination_full_condition_report", "subtype": "condition", "type": "handling" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "name": "Condition Report (origin)", "sub_subtype": "origin_full_condition_report", "subtype": "condition", "type": "handling" }, { "amount": "1", "amount_currency": "USD", "included_services": [ { "name": "Unpacking Soft Materials (destination)", "sub_subtype": "destination_unpacking_soft", "subtype": "unpacking", "type": "handling" } ], "name": "Unpacking (destination)", "sub_subtype": "destination_unpacking", "subtype": "unpacking", "type": "handling" } ], "quote_type": "premium", "status": "published", "total": "2", "total_currency": "USD" }, { "id": 62, "included_insurance_policy": null, "included_services": [ { "amount": "1", "amount_currency": "USD", "included_services": [ { "name": "Soft Packed Disposal", "sub_subtype": "soft_packed_disposal", "subtype": "debris_disposal", "type": "handling" } ], "is_requested": false, "is_required": true, "metadata": {}, "name": "Debris Disposal", "sub_subtype": "debris_disposal", "subtype": "debris_disposal", "type": "handling" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "is_requested": false, "is_required": true, "metadata": {}, "name": "Fuel Surcharge", "sub_subtype": "fuel_surcharge", "subtype": "fees", "type": "taxes_duties_fees" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "is_requested": false, "is_required": true, "metadata": {}, "name": "Strongbox", "sub_subtype": "strongbox", "subtype": "packing_materials", "type": "packing" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "is_requested": false, "is_required": true, "metadata": { "reference_rate": { "provider": "arta", "service_level": null } }, "name": "Consolidated Trucking", "sub_subtype": "road_groupage", "subtype": "consolidated", "type": "transport" } ], "optional_services": [ { "amount": "1", "amount_currency": "USD", "included_services": [ { "name": "Unpacking Soft Materials (destination)", "sub_subtype": "destination_unpacking_soft", "subtype": "unpacking", "type": "handling" } ], "name": "Unpacking (destination)", "sub_subtype": "destination_unpacking", "subtype": "unpacking", "type": "handling" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "name": "Condition Check (destination)", "sub_subtype": "destination_condition_check", "subtype": "condition", "type": "handling" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "name": "Condition Check (origin)", "sub_subtype": "origin_condition_check", "subtype": "condition", "type": "handling" } ], "quote_type": "select", "status": "published", "total": "4", "total_currency": "USD" }, { "id": 63, "included_insurance_policy": null, "included_services": [ { "amount": "1", "amount_currency": "USD", "included_services": [], "is_requested": false, "is_required": true, "metadata": {}, "name": "Fuel Surcharge", "sub_subtype": "fuel_surcharge", "subtype": "fees", "type": "taxes_duties_fees" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "is_requested": false, "is_required": true, "metadata": {}, "name": "Collection", "sub_subtype": "collection", "subtype": "collection", "type": "location" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "is_requested": false, "is_required": true, "metadata": {}, "name": "Ply Box", "sub_subtype": "ply_box", "subtype": "packing_materials", "type": "packing" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "is_requested": false, "is_required": true, "metadata": { "reference_rate": { "provider": "fedex", "service_level": "fedex_ground" } }, "name": "UPS Ground", "sub_subtype": "parcel", "subtype": "parcel", "type": "transport" } ], "optional_services": [], "quote_type": "parcel", "status": "published", "total": "4", "total_currency": "USD" }, { "id": 64, "included_insurance_policy": null, "included_services": [ { "amount": "1", "amount_currency": "USD", "included_services": [], "is_requested": false, "is_required": true, "metadata": {}, "name": "Fuel Surcharge", "sub_subtype": "fuel_surcharge", "subtype": "fees", "type": "taxes_duties_fees" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "is_requested": false, "is_required": true, "metadata": {}, "name": "Collection", "sub_subtype": "collection", "subtype": "collection", "type": "location" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "is_requested": false, "is_required": true, "metadata": {}, "name": "Ply Box", "sub_subtype": "ply_box", "subtype": "packing_materials", "type": "packing" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "is_requested": false, "is_required": true, "metadata": { "reference_rate": { "provider": "fedex", "service_level": "fedex_2_day" } }, "name": "UPS Second Day Air", "sub_subtype": "parcel", "subtype": "parcel", "type": "transport" } ], "optional_services": [], "quote_type": "parcel", "status": "published", "total": "4", "total_currency": "USD" }, { "id": 65, "included_insurance_policy": null, "included_services": [ { "amount": "1", "amount_currency": "USD", "included_services": [], "is_requested": false, "is_required": true, "metadata": {}, "name": "Fuel Surcharge", "sub_subtype": "fuel_surcharge", "subtype": "fees", "type": "taxes_duties_fees" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "is_requested": false, "is_required": true, "metadata": {}, "name": "Collection", "sub_subtype": "collection", "subtype": "collection", "type": "location" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "is_requested": false, "is_required": true, "metadata": {}, "name": "Ply Box", "sub_subtype": "ply_box", "subtype": "packing_materials", "type": "packing" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "is_requested": false, "is_required": true, "metadata": { "reference_rate": { "provider": "fedex", "service_level": "fedex_standard_overnight" } }, "name": "UPS Next Day Air", "sub_subtype": "parcel", "subtype": "parcel", "type": "transport" } ], "optional_services": [], "quote_type": "parcel", "status": "published", "total": "4", "total_currency": "USD" } ], "quoting_strategy": "best_rate", "shipping_notes": null, "shortcode": "DEMO-R29NAW", "status": "quoted", "tags": [], "updated_at": "2021-01-21T17:22:10.129653" }, "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", "example": "2021-01-21T21:00:58.403150", "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", "example": "USD", "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" ], "example": "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" ], "example": "ddu", "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", "example": "87 Richardson St", "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "Second line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "address_line_3": { "description": "Third line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "City", "example": "Brooklyn", "type": "string", "x-struct": null, "x-validate": null }, "contacts": { "description": "A list of contacts at the location", "items": { "properties": { "email_address": { "example": "docs@arta.io", "type": "string", "x-struct": null, "x-validate": null }, "name": { "example": "Contact Name", "type": "string", "x-struct": null, "x-validate": null }, "phone_number": { "example": "646 828 7333", "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", "example": "US", "maxLength": 2, "minLength": 2, "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "The postal code", "example": "11211", "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations", "example": "NY", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The title or name of the location", "example": "Gallery", "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", "example": 723, "nullable": true, "type": "integer", "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.", "example": "arta_transit_insurance", "nullable": true, "type": "string", "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, "nullable": true, "type": "string", "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", "example": "FoaokYpj364TxY8AR_qR", "type": "string", "x-struct": null, "x-validate": null }, "object_count": { "description": "The count of objects included in the initial request payload", "example": 1, "type": "number", "x-struct": null, "x-validate": null }, "objects": { "description": "A list of objects to be shipped", "items": { "$ref": "#/components/schemas/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", "example": "87 Richardson St", "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "Second line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "address_line_3": { "description": "Third line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "City", "example": "Brooklyn", "type": "string", "x-struct": null, "x-validate": null }, "contacts": { "description": "A list of contacts at the location", "items": { "properties": { "email_address": { "example": "docs@arta.io", "type": "string", "x-struct": null, "x-validate": null }, "name": { "example": "Contact Name", "type": "string", "x-struct": null, "x-validate": null }, "phone_number": { "example": "646 828 7333", "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", "example": "US", "maxLength": 2, "minLength": 2, "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "The postal code", "example": "11211", "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations", "example": "NY", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The title or name of the location", "example": "Gallery", "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" ], "example": "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.", "example": [ "ground" ], "items": { "type": "string", "x-struct": null, "x-validate": null }, "nullable": true, "type": "array", "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, "nullable": true, "type": "string", "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", "example": "[\"select\"]", "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": { "nullable": true, "properties": { "amount": { "example": "2500.00", "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", "example": "USD", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "title": "Currency", "type": "string", "x-struct": null, "x-validate": null }, "id": { "example": "arta_transit_insurance", "type": "string", "x-struct": null, "x-validate": null }, "insured_value": { "example": "2500.00", "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", "example": "USD", "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 }, "included_services": { "items": { "properties": { "amount": { "example": "2500.00", "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", "example": "USD", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "title": "Currency", "type": "string", "x-struct": null, "x-validate": null }, "included_services": { "items": { "properties": { "name": { "example": "Unpacking Soft Materials", "type": "string", "x-struct": null, "x-validate": null }, "sub_subtype": { "example": "destination_unpacking_soft", "type": "string", "x-struct": null, "x-validate": null }, "subtype": { "example": "unpacking", "type": "string", "x-struct": null, "x-validate": null }, "type": { "example": "handling", "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", "example": {}, "type": "object", "x-struct": null, "x-validate": null }, "name": { "example": "Unpacking (destination)", "type": "string", "x-struct": null, "x-validate": null }, "sub_subtype": { "example": "destination_unpacking", "type": "string", "x-struct": null, "x-validate": null }, "subtype": { "example": "unpacking", "type": "string", "x-struct": null, "x-validate": null }, "type": { "example": "handling", "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": { "example": "2500.00", "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", "example": "USD", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "title": "Currency", "type": "string", "x-struct": null, "x-validate": null }, "included_services": { "items": { "properties": { "name": { "example": "Unpacking Soft Materials", "type": "string", "x-struct": null, "x-validate": null }, "sub_subtype": { "example": "destination_unpacking_soft", "type": "string", "x-struct": null, "x-validate": null }, "subtype": { "example": "unpacking", "type": "string", "x-struct": null, "x-validate": null }, "type": { "example": "handling", "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": { "example": "Unpacking (destination)", "type": "string", "x-struct": null, "x-validate": null }, "sub_subtype": { "example": "destination_unpacking", "type": "string", "x-struct": null, "x-validate": null }, "subtype": { "example": "unpacking", "type": "string", "x-struct": null, "x-validate": null }, "type": { "example": "handling", "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": { "example": "select", "type": "string", "x-struct": null, "x-validate": null }, "status": { "example": "published", "type": "string", "x-struct": null, "x-validate": null }, "tags": { "description": "A list of tags associated with this request", "items": { "$ref": "#/components/schemas/Tag" }, "type": "array", "x-struct": null, "x-validate": null }, "total": { "example": "2500.00", "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", "example": "USD", "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" ], "example": "best_rate", "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", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "shortcode": { "description": "A brief and unique string identifier for the resource", "example": "DEMO-B8FIRV", "type": "string", "x-struct": null, "x-validate": null }, "status": { "enum": [ "quoted", "in_progress", "cancelled", "closed", "disqualified", "expired", "pending" ], "example": "quoted", "type": "string", "x-struct": null, "x-validate": null }, "tags": { "description": "A list of tags associated with this request", "items": { "$ref": "#/components/schemas/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", "example": "2021-01-21T21:00:58.403150", "type": "string", "x-struct": null, "x-validate": null } }, "title": "Request", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.Request", "x-validate": null }, "BookingSession": { "additionalProperties": false, "description": "Create hosted booking session", "properties": { "hosted_session": { "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, meaning this may disqualify certain segments of shipping services we offer.", "items": { "description": "The id of a service.", "example": "signature_delivery", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "cancel_url": { "description": "The URL the user will be redirected to after a Arta Booking session is cancelled", "example": "http://example.com/cancelled", "type": "string", "x-struct": null, "x-validate": null }, "customs_end_use": { "default": "not_for_resale", "description": "The intended end use of the items being shipped for customs purposes", "enum": [ "for_resale", "not_for_resale" ], "example": "not_for_resale", "type": "string", "x-struct": null, "x-validate": null }, "customs_process": { "default": "ddu", "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" ], "example": "ddu", "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", "example": "87 Richardson St", "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "Second line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "address_line_3": { "description": "Third line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "City", "example": "Brooklyn", "type": "string", "x-struct": null, "x-validate": null }, "contacts": { "description": "A list of contacts at the location", "items": { "properties": { "email_address": { "example": "docs@arta.io", "type": "string", "x-struct": null, "x-validate": null }, "name": { "example": "Contact Name", "type": "string", "x-struct": null, "x-validate": null }, "phone_number": { "example": "646 828 7333", "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", "example": "US", "maxLength": 2, "minLength": 2, "required": true, "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "The postal code", "example": "11211", "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations", "example": "NY", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The title or name of the location", "example": "Gallery", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "insurance": { "description": "The ID of the requested Arta insurance type. Options are defined in the Insurances metadata endpoint", "example": "arta_transit_insurance", "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", "example": "Purchase Order: 2801", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "objects": { "items": { "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", "example": "US", "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", "example": "123456", "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", "example": "oil on canvas", "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", "example": true, "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", "example": "1980", "type": "string", "x-struct": null, "x-validate": null }, "creator": { "description": "The creator of the object", "example": "Bob Smithson", "type": "string", "x-struct": null, "x-validate": null }, "notes": { "description": "Any notes about the item", "example": "Artist signature in the lower left corner", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The object title", "example": "Black Rectangle", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "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", "example": "Accession ID: 823", "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", "example": "Round Smithson work", "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", "example": "painting_framed", "pattern": "^[0-9a-z_]{1,56}$", "type": "string", "x-struct": null, "x-validate": null }, "value": { "$ref": "#/components/schemas/MonetaryAmount" }, "value_currency": { "$ref": "#/components/schemas/Currency" } }, "required": [ "type", "value" ], "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": { "example": "no_packing", "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", "example": "US", "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", "example": "123456", "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", "example": "oil on canvas", "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", "example": true, "type": "boolean", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "depth": { "description": "The depth of the object", "example": "3", "type": "string", "x-struct": null, "x-validate": null }, "details": { "properties": { "creation_date": { "description": "Details about the timing in which an object was created", "example": "1980", "type": "string", "x-struct": null, "x-validate": null }, "creator": { "description": "The creator of the object", "example": "Bob Smithson", "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": { "example": "canvas", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "notes": { "description": "Any notes about the item", "example": "Artist signature in the lower left corner", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The object title", "example": "Black Rectangle", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "height": { "description": "The height of the object", "example": "32", "type": "string", "x-struct": null, "x-validate": null }, "images": { "description": "A list image urls of the object", "items": { "example": "http://example.com/image.jpg", "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", "example": "Accession ID: 823", "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", "example": "Round Smithson work", "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", "example": "painting_unframed", "pattern": "^[0-9a-z_]{1,56}$", "type": "string", "x-struct": null, "x-validate": null }, "unit_of_measurement": { "enum": [ "in", "cm" ], "example": "in", "type": "string", "x-struct": null, "x-validate": null }, "value": { "$ref": "#/components/schemas/MonetaryAmount" }, "value_currency": { "$ref": "#/components/schemas/Currency" }, "weight": { "description": "The weight of the object", "example": "3.0", "type": "string", "x-struct": null, "x-validate": null }, "weight_unit": { "description": "The unit of the object", "enum": [ "lb", "kg" ], "example": "lb", "type": "string", "x-struct": null, "x-validate": null }, "width": { "description": "The width of the object", "example": "15", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "depth", "height", "subtype", "width", "unit_of_measurement", "weight_unit", "value", "value_currency" ], "type": "object", "x-struct": null, "x-validate": null }, "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", "example": "87 Richardson St", "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "Second line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "address_line_3": { "description": "Third line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "City", "example": "Brooklyn", "type": "string", "x-struct": null, "x-validate": null }, "contacts": { "description": "A list of contacts at the location", "items": { "properties": { "email_address": { "example": "docs@arta.io", "type": "string", "x-struct": null, "x-validate": null }, "name": { "example": "Contact Name", "type": "string", "x-struct": null, "x-validate": null }, "phone_number": { "example": "646 828 7333", "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", "example": "US", "maxLength": 2, "minLength": 2, "required": true, "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "The postal code", "example": "11211", "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations", "example": "NY", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The title or name of the location", "example": "Gallery", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "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.", "example": [ "ground" ], "items": { "type": "string", "x-struct": null, "x-validate": null }, "nullable": true, "type": "array", "x-struct": null, "x-validate": null }, "preferred_quote_types": { "description": "Optionally instruct the Arta API to return a subset of quote types for the requests generated through this hosted session. For example if you would prefer to only return Select quotes, you can set this field to `[\"select\"]` The list valid quote type IDs are available at the /metadata/quotes endpoint.", "example": [ "parcel" ], "items": { "type": "string", "x-struct": null, "x-validate": null }, "nullable": true, "type": "array", "x-struct": null, "x-validate": null }, "public_instructions_booking_review": { "description": "A client defined multi-line block of text presented to users in the quote review modal window prior to booking a shipment for booking, shared request, and inbound booking sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "type": "string", "x-struct": null, "x-validate": null }, "public_instructions_confirmation": { "description": "A client defined multi-line block of text presented to users on the post-shipment booking confirmation view for booking, shared request, and inbound booking hosted sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "type": "string", "x-struct": null, "x-validate": null }, "public_instructions_location_quotes": { "description": "A client defined multi-line block of text presented to users on the location and quote selection view for booking, shared request, and inbound booking hosted sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "type": "string", "x-struct": null, "x-validate": null }, "public_instructions_payment": { "description": "A client defined multi-line block of text presented to users on the post-shipment booking payment view when required for booking, shared request, and inbound booking hosted sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "type": "string", "x-struct": null, "x-validate": null }, "public_reference": { "description": "A client defined name for the request. The value provided for the public_reference field may appear in notification emails and shipment detail pages", "example": "Order #1437", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "quoting_strategy": { "default": "best_rate", "description": "The quoting strategy used when creating quote requests for this booking session. Determines whether the API returns a single best-rate option per transport speed or multiple carrier options for comparison", "enum": [ "best_rate", "compare_carriers" ], "example": "best_rate", "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", "example": "New customer", "type": "string", "x-struct": null, "x-validate": null }, "success_url": { "description": "The URL the user will be redirected to after a Arta Booking session is completed", "example": "http://example.com/success", "type": "string", "x-struct": null, "x-validate": null }, "tags": { "description": "A list of tags to associate with this hosted session", "items": { "description": "The name of an active tag belonging to your organization.", "example": "spring-jewelry-sale", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "type": { "default": "booking", "description": "The type of the hosted session", "enum": [ "booking" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "objects", "origin" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "hosted_session" ], "title": "BookingSession", "type": "object", "x-struct": null, "x-validate": null }, "ArtaShipmentPayload": { "additionalProperties": false, "description": "Create a standard Arta shipment", "properties": { "shipment": { "properties": { "customs_process": { "default": "ddu", "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" ], "example": "ddu", "type": "string", "x-struct": null, "x-validate": null }, "exceptions": { "description": "An optional list of exceptions to apply at booking time. Only supported for self-ship shipments. Pass an item with `type: \"label_hold\"` to defer automatic label purchase until the exception is resolved.", "items": { "properties": { "type": { "description": "The exception type to create at booking. Currently the only accepted value is `label_hold`.", "enum": [ "label_hold" ], "example": "label_hold", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "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", "example": "Purchase Order: 2801", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "public_reference": { "description": "A client defined name for the request. The value provided for the public_reference field may appear in notification emails and shipment detail pages", "example": "Order #1437", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "quote_id": { "description": "The numeric id of the quote to be booked", "example": "12345", "format": "int64", "type": "integer", "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", "example": "New customer", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "tags": { "description": "A list of tags to associate with this shipment. Tags present on the request will also be set on the shipment", "items": { "description": "The name of an active tag belonging to your organization.", "example": "vip", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "quote_id" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "shipment" ], "title": "ArtaShipmentPayload", "type": "object", "x-struct": null, "x-validate": null }, "Location": { "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", "example": "87 Richardson St", "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "Second line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "address_line_3": { "description": "Third line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "City", "example": "Brooklyn", "type": "string", "x-struct": null, "x-validate": null }, "contacts": { "description": "A list of contacts at the location", "items": { "properties": { "email_address": { "example": "docs@arta.io", "type": "string", "x-struct": null, "x-validate": null }, "name": { "example": "Contact Name", "type": "string", "x-struct": null, "x-validate": null }, "phone_number": { "example": "646 828 7333", "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", "example": "US", "maxLength": 2, "minLength": 2, "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "The postal code", "example": "11211", "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations", "example": "NY", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The title or name of the location", "example": "Gallery", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "country" ], "title": "Location", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.Location", "x-validate": null }, "MetadataObjectMaterial": { "items": { "properties": { "description": { "description": "A long form description of the currency", "example": "a strong, coarse unbleached cloth made from hemp, flax, cotton, or a similar yarn", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The ID representing the resource", "example": "canvas", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "A brief label for the resource", "example": "Canvas", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "title": "MetadataObjectMaterial", "type": "array", "x-struct": "Elixir.DocsWeb.Schemas.Response.Metadata.ObjectMaterial", "x-validate": null }, "Service": { "properties": { "amount": { "$ref": "#/components/schemas/MonetaryAmount" }, "amount_currency": { "$ref": "#/components/schemas/Currency" }, "included_services": { "description": "A list of service IDs that are included in the service", "items": { "properties": { "name": { "description": "The name of the service", "example": "Consolidated Trucking", "type": "string", "x-struct": null, "x-validate": null }, "sub_subtype": { "description": "The service subsubtype ID. Options are defined in the Service types metadata endpoint", "example": "road_groupage", "pattern": "^[0-9a-z_]{1,56}$", "type": "string", "x-struct": null, "x-validate": null }, "subtype": { "description": "The service subtype ID. Options are defined in the Service types metadata endpoint", "example": "consolidated", "pattern": "^[0-9a-z_]{1,56}$", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "The service type ID. Options are defined in the Service types metadata endpoint", "example": "transport", "pattern": "^[0-9a-z_]{1,56}$", "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": { "description": "Set this flag to true if the service is requested", "type": "boolean", "x-struct": null, "x-validate": null }, "is_required": { "description": "Set this flag to true if the service 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", "example": {}, "type": "object", "x-struct": null, "x-validate": null }, "name": { "description": "The name of the service", "example": "Consolidated Trucking", "type": "string", "x-struct": null, "x-validate": null }, "sub_subtype": { "description": "The service subsubtype ID. Options are defined in the Service types metadata endpoint", "example": "road_groupage", "pattern": "^[0-9a-z_]{1,56}$", "type": "string", "x-struct": null, "x-validate": null }, "subtype": { "description": "The service subtype ID. Options are defined in the Service types metadata endpoint", "example": "consolidated", "pattern": "^[0-9a-z_]{1,56}$", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "The service type ID. Options are defined in the Service types metadata endpoint", "example": "transport", "pattern": "^[0-9a-z_]{1,56}$", "type": "string", "x-struct": null, "x-validate": null } }, "title": "Service", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.Service", "x-validate": null }, "EmailRuleCreate": { "additionalProperties": false, "properties": { "email_rule": { "properties": { "email_notification_id": { "description": "The ID belonging to the Email Notification for this Email Rule.", "example": "booking", "type": "string", "x-struct": null, "x-validate": null }, "recipients": { "description": "The list of recipients for this Email Rule.", "example": [ "destination", "origin" ], "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "email_notification_id", "recipients" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "email_rule" ], "title": "EmailRuleCreate", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.EmailRuleCreate", "x-validate": null }, "MetadataEmailNotification": { "items": { "properties": { "description": { "description": "A long form description", "example": "Delivered when a shipment is confirmed.", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The ID representing the resource", "example": "booking", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "A brief title for the resource", "example": "Booking Confirmation", "type": "string", "x-struct": null, "x-validate": null }, "optional_recipients": { "description": "The list of configurable recipients for this notification", "items": { "example": "destination", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "title": "MetadataEmailNotification", "type": "array", "x-struct": "Elixir.DocsWeb.Schemas.Response.Metadata.EmailNotification", "x-validate": null }, "EmailSubscriptionCreate": { "additionalProperties": false, "properties": { "email_subscription": { "properties": { "email_address": { "description": "The email_address for this Email Subscription.", "example": "hello@shiparta.com", "type": "string", "x-struct": null, "x-validate": null }, "email_notification_ids": { "description": "The list of Email Notification IDs for this Email Subscription.", "example": [ "booking", "scheduling" ], "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "name": { "description": "The name for this Email Subscription. This name will be used in conjunction with the email address field to build the recipient when delivering email notifications.", "example": "Arta", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "email_subscription" ], "title": "EmailSubscriptionCreate", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.EmailSubscriptionCreate", "x-validate": null }, "NullableLocation": { "nullable": true, "properties": { "access_restrictions": { "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", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "address_line_3": { "description": "Third line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "City", "type": "string", "x-struct": null, "x-validate": null }, "contacts": { "description": "An 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 } }, "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 }, "id": { "description": "The location id", "readOnly": true, "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 } }, "title": "NullableLocation", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.NullableLocation", "x-validate": null }, "MetadataShipmentStatus": { "items": { "properties": { "description": { "description": "A long form description", "example": "A quote has been booked and is awaiting confirmation by an Arta logistics specialist", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The ID representing the resource", "example": "pending", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "A brief title for the resource", "example": "Pending", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "title": "MetadataShipmentStatus", "type": "array", "x-struct": "Elixir.DocsWeb.Schemas.Response.Metadata.ShipmentStatus", "x-validate": null }, "Tracking": { "example": { "carrier": { "code": "ups", "name": "UPS", "phone_number": "+1 800-742-5877", "url": "https://www.ups.com/us/en/Home.page" }, "events": [ { "date": "2020-10-20 13:53", "location": "BROOKLYN,NY,11249,US", "summary": "DELIVERED" }, { "date": "2020-10-20 08:58", "location": "Maspeth,NY,US", "summary": "Out For Delivery Today" }, { "date": "2020-10-20 05:23", "location": "Maspeth,NY,US", "summary": "Loaded on Delivery Vehicle" }, { "date": "2020-10-20 05:02", "location": "Maspeth,NY,US", "summary": "Destination Scan" }, { "date": "2020-10-20 04:08", "location": "Maspeth,NY,US", "summary": "Arrived at Facility" }, { "date": "2020-10-20 03:11", "location": "Saddle Brook,NJ,US", "summary": "Departed from Facility" }, { "date": "2020-10-20 00:42", "location": "Saddle Brook,NJ,US", "summary": "Arrived at Facility" }, { "date": "2020-10-19 21:17", "location": "Carlisle,PA,US", "summary": "Departed from Facility" }, { "date": "2020-10-19 18:04", "location": "Carlisle,PA,US", "summary": "Origin Scan" }, { "date": "2020-10-19 10:34", "location": "US", "summary": "Order Processed: Ready for UPS" } ], "status": "DELIVERED", "tracking_number": "1Z06************" }, "properties": { "carrier": { "properties": { "code": { "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 }, "url": { "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "events": { "items": { "properties": { "code": { "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 }, "url": { "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "status": { "type": "string", "x-struct": null, "x-validate": null }, "tracking_number": { "type": "string", "x-struct": null, "x-validate": null } }, "title": "Tracking", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.Tracking", "x-validate": null }, "MetadataObjectComponent": { "items": { "properties": { "description": { "description": "A long form description", "example": "A painting that is framed behind a glass face.", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The ID representing the resource", "example": "painting_framed_glass", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "A brief title for the resource", "example": "Painting (framed with glass)", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "title": "MetadataObjectComponent", "type": "array", "x-struct": "Elixir.DocsWeb.Schemas.Response.Metadata.ObjectComponent", "x-validate": null }, "AddressVerification": { "example": { "created_at": "2025-06-15T12:00:00.000000", "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "input": { "address_line_1": "123 Main St", "address_line_2": "Apt 4B", "address_line_3": null, "city": "New York", "country": "US", "postal_code": "10001", "region": "NY" }, "match_level": "delivery_point", "recommendation": { "address_line_1": "123 Main Street", "address_line_2": "Apt 4B", "address_line_3": null, "city": "New York", "country": "US", "is_residential": true, "latitude": 40.7128, "longitude": -74.006, "postal_code": "10001-1234", "region": "NY" }, "reference": "order-12345", "shortcode": "ACME-V1A2B3", "status": "success", "updated_at": "2025-06-15T12:00:00.000000" }, "properties": { "created_at": { "description": "A NaiveDatetime-formatted timestamp describing when the resource was created with microsecond precision", "example": "2025-06-15T12:00:00.000000", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The id of the address verification in UUID format", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "input": { "description": "The original address as submitted", "properties": { "address_line_1": { "description": "Primary street address line", "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "Secondary address line (apartment, suite, unit, etc.)", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "address_line_3": { "description": "Tertiary address line. Used for some international formats", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "City or locality name", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "country": { "description": "ISO 3166-1 alpha-2 country code", "example": "US", "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "Postal or ZIP code", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "State, province, or region code", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "match_level": { "description": "The granularity of the address match, from most to least precise", "enum": [ "delivery_point", "premise", "thoroughfare", "locality", "administrative_area", "none" ], "example": "delivery_point", "type": "string", "x-struct": null, "x-validate": null }, "recommendation": { "description": "The verified and corrected address with geocoding data. Fields may be null if verification failed", "properties": { "address_line_1": { "description": "Corrected primary street address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "Corrected secondary address line", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "address_line_3": { "description": "Corrected tertiary address line", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "Corrected city or locality", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "country": { "description": "ISO 3166-1 alpha-2 country code", "example": "US", "type": "string", "x-struct": null, "x-validate": null }, "is_residential": { "description": "Whether the address is classified as residential. US addresses only; null for international or when unknown", "nullable": true, "type": "boolean", "x-struct": null, "x-validate": null }, "latitude": { "description": "Latitude coordinate of the verified address", "format": "float", "nullable": true, "type": "number", "x-struct": null, "x-validate": null }, "longitude": { "description": "Longitude coordinate of the verified address", "format": "float", "nullable": true, "type": "number", "x-struct": null, "x-validate": null }, "postal_code": { "description": "Corrected postal code. For US addresses, may include the +4 extension (e.g., `10001-1234`)", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "Corrected state, province, or region", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "reference": { "description": "An optional client-provided reference string for correlating with your own records", "example": "order-12345", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "shortcode": { "description": "A human-readable identifier for the address verification prefixed with the organization's shortcode", "example": "ACME-V1A2B3", "type": "string", "x-struct": null, "x-validate": null }, "status": { "description": "The verification outcome", "enum": [ "success", "partial", "failed" ], "example": "success", "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", "example": "2025-06-15T12:00:00.000000", "type": "string", "x-struct": null, "x-validate": null } }, "title": "AddressVerification", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.AddressVerification", "x-validate": null }, "BadRequest": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "BadRequest", "type": "object", "x-struct": null, "x-validate": null }, "Error": { "properties": { "errors": { "properties": { "detail": { "description": "A human-readable explanation specific to this occurrence of the problem", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "Error", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.Error", "x-validate": null }, "Tag": { "example": { "color": "008000", "created_at": "2024-09-25T19:17:54.871490", "created_by": null, "description": null, "id": "f7e4b35b-5131-47c2-9a88-238bd6e62e2d", "is_active": false, "name": "ct-warehouse", "updated_at": "2024-09-25T19:19:01.648283", "updated_by": null }, "properties": { "color": { "description": "The hexadecimal color code for the tag, without the leading `#`.", "example": "0000FF", "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", "example": "2024-08-13T22:44:39.593704", "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", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "description": { "description": "An optional, brief description for this tag.", "maxLength": 255, "nullable": true, "type": "string", "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.", "example": "la-warehouse", "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", "example": "2024-08-13T22:44:39.593704", "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", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null } }, "title": "Tag", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.Tag", "x-validate": null }, "TagUpdate": { "additionalProperties": false, "properties": { "tag": { "properties": { "color": { "description": "The hexadecimal color code for the tag, without the leading `#`.", "example": "0000FF", "maxLength": 6, "minLength": 6, "pattern": "^[0-9A-F]{6}$", "type": "string", "x-struct": null, "x-validate": null }, "description": { "description": "An optional, brief description for this tag.", "maxLength": 255, "nullable": true, "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", "nullable": true, "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.", "example": "la-warehouse", "maxLength": 50, "pattern": "^[a-z0-9-]{1,50}$", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "tag" ], "title": "TagUpdate", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.TagUpdate", "x-validate": null }, "Attachment": { "example": { "created_at": "2021-10-27T16:48:38.657228", "id": 1942, "request_id": "506d79b6-1e5e-4e8c-a266-74658fdaf4ee", "shipment_id": null, "updated_at": "2021-10-27T16:48:38.657228", "upload_id": 4791 }, "properties": { "created_at": { "example": "2021-10-27T16:48:38.657228", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "id": { "example": 1942, "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "request_id": { "description": "The string ID of the request resource associated to an upload via this attachment. Null if this attachment associate a shipment", "example": "506d79b6-1e5e-4e8c-a266-74658fdaf4ee", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "shipment_id": { "description": "The string ID of the shipment resource associated to an upload via this attachment. Null if this attachment associate a request", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "example": "2021-10-27T16:48:38.657228", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "upload_id": { "description": "The integer ID of the Upload resource associated with either a shipment or request via this attachment", "example": 4791, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "upload_id" ], "title": "Attachment", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.Attachment", "x-validate": null }, "HostedSession": { "example": { "additional_services": [ "signature_delivery" ], "can_user_confirm_object_dimensions": false, "cancel_url": "http://example.com/cancel", "created_at": "2021-01-21T17:22:08.818747", "customs_end_use": "not_for_resale", "customs_process": "ddu", "destination": null, "id": 42, "insurance": null, "internal_reference": null, "objects": [ { "components": [ { "customs": { "country_of_origin": "US", "hs_code": "123456", "medium": "oil on canvas", "temporary_admission": true }, "details": { "creation_date": "1980", "creator": "Bob Smithson", "notes": "Artist signature in the lower left corner", "title": "Black Rectangle" }, "id": "1f26b6e1-ce25-43a9-b4ea-2ceaac24ec3a", "internal_reference": "Accession ID: 823", "public_reference": "Round Smithson work", "type": "painting_framed", "value": "15000", "value_currency": "USD" } ], "current_packing": [ "cardboard_box" ], "depth": "2", "details": { "creation_date": null, "creator": null, "is_cites": false, "is_fragile": false, "materials": [], "notes": null, "title": null }, "height": "10.5", "id": 12346, "images": [], "internal_reference": null, "public_reference": null, "subtype": "prepacked_box", "type": "client_package", "unit_of_measurement": "in", "value": "15000", "value_currency": "USD", "weight": "3.5", "weight_unit": "lb", "width": "10" }, { "components": [], "current_packing": [], "customs": { "country_of_origin": "US", "hs_code": "123456", "medium": "oil on canvas", "temporary_admission": true }, "depth": "2", "details": { "creation_date": null, "creator": "Robert Irwin", "is_cites": false, "is_fragile": false, "materials": [], "notes": "notes", "title": "It's just jazz" }, "height": "24", "id": 12345, "images": [], "internal_reference": null, "public_reference": null, "subtype": "painting_unframed", "type": "art", "unit_of_measurement": "in", "value": "100.00", "value_currency": "USD", "weight": "1", "weight_unit": "lb", "width": "36" } ], "origin": { "access_restrictions": [], "address_line_1": "11 W 53rd St", "address_line_2": null, "address_line_3": null, "city": "New York", "contacts": [ { "email_address": "mary@example.com", "name": "Mary Quinn Sullivan", "phone_number": "(333) 333-3333" } ], "country": "US", "postal_code": "10019", "region": "NY", "title": "Warehouse" }, "payment_process": "invoicing", "preferred_quote_types": [], "private_token": "6f76b6e1-ce25-43a9-b4ea-2ceaac24ec7e", "public_instructions_booking_review": null, "public_instructions_confirmation": null, "public_instructions_location_quotes": null, "public_instructions_object_details": null, "public_instructions_payment": null, "public_reference": null, "quoting_strategy": "best_rate", "shipping_notes": null, "shortcode": "DEMO-B49SVZ", "status": "new", "success_url": "http://example.com/success", "tags": [], "type": "booking", "updated_at": "2021-01-21T17:22:10.129653", "url": "https://book.arta.io/b/42/6f76b6e1-ce25-43a9-b4ea-2ceaac24ec7e" }, "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 }, "can_user_confirm_object_dimensions": { "description": "Determines whether your customer can verify and update object dimension information when completing an inbound booking session.", "type": "boolean", "x-struct": null, "x-validate": null }, "cancel_url": { "description": "The URL the user will be redirected to after an Arta Booking session is cancelled", "type": "string", "x-struct": null, "x-validate": null }, "created_at": { "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" ], "example": "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" ], "example": "ddu", "type": "string", "x-struct": null, "x-validate": null }, "destination": { "$ref": "#/components/schemas/NullableLocation" }, "id": { "format": "int64", "type": "integer", "x-struct": null, "x-validate": null }, "insurance": { "description": "The id of an insurance type. If requesting Arta insurance, object values must be provided.", "example": "arta_transit_insurance", "nullable": true, "type": "string", "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, "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "objects": { "description": "A list of objects to be shipped", "items": { "$ref": "#/components/schemas/Object" }, "type": "array", "x-struct": null, "x-validate": null }, "origin": { "$ref": "#/components/schemas/Location" }, "payment_process": { "description": "The primary method by which payment to Arta will be handled for any shipment booked through this hosted session", "enum": [ "checkout", "invoicing" ], "example": "checkout", "readOnly": true, "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.", "example": [ "ground" ], "items": { "type": "string", "x-struct": null, "x-validate": null }, "nullable": true, "type": "array", "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 hosted session", "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "private_token": { "description": "A private access token for this resource. It is used to generate the private URL for the hosted session", "type": "string", "x-struct": null, "x-validate": null }, "public_instructions_booking_review": { "description": "A client defined multi-line block of text presented to users in the quote review modal window prior to booking a shipment for booking, shared request, and inbound booking sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "type": "string", "x-struct": null, "x-validate": null }, "public_instructions_confirmation": { "description": "A client defined multi-line block of text presented to users on the post-shipment booking confirmation view for booking, shared request, and inbound booking hosted sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "type": "string", "x-struct": null, "x-validate": null }, "public_instructions_location_quotes": { "description": "A client defined multi-line block of text presented to users on the location and quote selection view for booking, shared request, and inbound booking hosted sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "type": "string", "x-struct": null, "x-validate": null }, "public_instructions_object_details": { "description": "A client defined multi-line block of text presented to users on the object form in inbound booking hosted sessions.\n\n- Only visible if `can_user_confirm_object_dimensions` is true\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "example": "Please confirm the dimensions of the objects you are shipping.", "type": "string", "x-struct": null, "x-validate": null }, "public_instructions_payment": { "description": "A client defined multi-line block of text presented to users on the post-shipment booking payment view when required for booking, shared request, and inbound booking hosted sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "type": "string", "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, "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "quoting_strategy": { "default": "best_rate", "description": "The quoting strategy used when creating quote requests for this booking session. Determines whether the API returns a single best-rate option per transport speed or multiple carrier options for comparison", "enum": [ "best_rate", "compare_carriers" ], "example": "best_rate", "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", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "shortcode": { "description": "A brief and unique string identifier for the resource", "example": "DEMO-B8FIRV", "type": "string", "x-struct": null, "x-validate": null }, "status": { "example": "quoted", "type": "string", "x-struct": null, "x-validate": null }, "success_url": { "description": "The URL the user will be redirected to after an Arta Booking session is completed", "type": "string", "x-struct": null, "x-validate": null }, "tags": { "description": "A list of tags associated with this hosted session", "items": { "$ref": "#/components/schemas/Tag" }, "type": "array", "x-struct": null, "x-validate": null }, "type": { "description": "The type of the hosted session", "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "type": "string", "x-struct": null, "x-validate": null }, "url": { "description": "The Arta Booking web URL for this Hosted Session", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "title": "HostedSession", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.HostedSession", "x-validate": null }, "AddressVerificationCreate": { "additionalProperties": false, "properties": { "address_verification": { "properties": { "input": { "properties": { "address_line_1": { "description": "Primary street address", "example": "123 Main St", "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "Secondary address (apartment, suite, etc.)", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "address_line_3": { "description": "Tertiary address line", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "City or locality", "example": "New York", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "country": { "description": "ISO 3166-1 alpha-2 country code", "example": "US", "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "Postal or ZIP code", "example": "10001", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "State, province, or region", "example": "NY", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "address_line_1", "country" ], "type": "object", "x-struct": null, "x-validate": null }, "reference": { "description": "Your own reference ID for correlation", "example": "order-12345", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "input" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "address_verification" ], "title": "AddressVerificationCreate", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.AddressVerificationCreate", "x-validate": null }, "Currency": { "default": "USD", "description": "ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint", "example": "USD", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "title": "Currency", "type": "string", "x-struct": null, "x-validate": null }, "Payment": { "example": { "amount": "502.25", "amount_currency": "USD", "context": "hosted_checkout", "created_at": "2021-02-19T19:09:57.954437", "id": 1, "paid_on": "2021-02-19", "updated_at": "2021-02-19T19:09:57.954437" }, "properties": { "amount": { "type": "string", "x-struct": null, "x-validate": null }, "amount_currency": { "type": "string", "x-struct": null, "x-validate": null }, "context": { "type": "string", "x-struct": null, "x-validate": null }, "created_at": { "type": "string", "x-struct": null, "x-validate": null }, "id": { "type": "integer", "x-struct": null, "x-validate": null }, "paid_on": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "type": "string", "x-struct": null, "x-validate": null } }, "title": "Payment", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.Payment", "x-validate": null }, "ShipmentExceptionCreate": { "example": { "shipment_exception": { "hold_until": "2023-08-15", "shipment_id": "5baff45a-281d-416e-9310-a4a7c637952e", "type": "requested_hold_to_collect" } }, "properties": { "shipment_exception": { "properties": { "hold_until": { "description": "Optionally provide a date to hold collection for the shipment. Values should be in the `YYYY-MM-DD` format. Hold until dates must be fewer than 30 days from the shipment's `created_at` datetime.", "type": "string", "x-struct": null, "x-validate": null }, "shipment_id": { "description": "The ID for the shipment associated to the shipment exception", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "The type ID for this resource. Options are defined in the Shipment Exception Types metadata endpoint. Currently, the only accepted type for client-created shipment exceptions is `requested_hold_to_collect`.", "enum": [ "requested_hold_to_collect" ], "example": "requested_hold_to_collect", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type", "shipment_id" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "shipment_exception" ], "title": "ShipmentExceptionCreate", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.ShipmentExceptionCreate", "x-validate": null }, "MetadataInsurance": { "items": { "properties": { "description": { "description": "A long form description", "example": "Arta full risk coverage transit insurance.", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The ID representing the resource", "example": "arta_transit_insurance", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "A brief title for the resource", "example": "Arta Full Risk", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "title": "MetadataInsurance", "type": "array", "x-struct": "Elixir.DocsWeb.Schemas.Response.Metadata.Insurance", "x-validate": null }, "MetadataService": { "items": { "properties": { "description": { "description": "A long form description", "example": "All handling for items at location and in transit.", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The ID representing the resource", "example": "handling", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "A brief title for the resource", "example": "Handling Services", "type": "string", "x-struct": null, "x-validate": null }, "subtypes": { "description": "The subtypes for this resource", "items": { "description": "An object subtype", "properties": { "description": { "description": "A long form description", "example": "All installation services.", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The ID representing the resource", "example": "installation", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "A brief title for the resource", "example": "Installation", "type": "string", "x-struct": null, "x-validate": null }, "sub_subtypes": { "description": "The subtypes for this resource", "items": { "description": "An object subtype", "properties": { "description": { "description": "A long form description", "example": "Object assembly at the destination", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The ID representing the resource", "example": "assembly", "type": "string", "x-struct": null, "x-validate": null }, "is_requestable": { "description": "Whether this service is requestable by the client", "example": true, "type": "boolean", "x-struct": null, "x-validate": null }, "name": { "description": "A brief title for the resource", "example": "Assembly", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "title": "MetadataService", "type": "array", "x-struct": "Elixir.DocsWeb.Schemas.Response.Metadata.Service", "x-validate": null }, "TrackShipmentPayload": { "additionalProperties": false, "description": "Create a track shipment", "properties": { "shipment": { "properties": { "destination": { "description": "The destination location for the shipment. If provided, the data in this object will overwrite the destination address data for this shipment that is stored on Arta's system, not the one on the commercial carrier's system", "nullable": true, "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", "example": "87 Richardson St", "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "Second line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "address_line_3": { "description": "Third line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "City", "example": "Brooklyn", "type": "string", "x-struct": null, "x-validate": null }, "contacts": { "description": "A list of contacts at the location", "items": { "properties": { "email_address": { "example": "docs@arta.io", "type": "string", "x-struct": null, "x-validate": null }, "name": { "example": "Contact Name", "type": "string", "x-struct": null, "x-validate": null }, "phone_number": { "example": "646 828 7333", "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", "example": "US", "maxLength": 2, "minLength": 2, "required": true, "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "The postal code", "example": "11211", "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations", "example": "NY", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The title or name of the location", "example": "Gallery", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "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", "example": "Purchase Order: 2801", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "origin": { "description": "The originating location for the shipment. If provided, the data in this object will overwrite the origin address data for this shipment that is stored on Arta's system, not the one on the commercial carrier's system", "nullable": true, "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", "example": "87 Richardson St", "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "Second line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "address_line_3": { "description": "Third line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "City", "example": "Brooklyn", "type": "string", "x-struct": null, "x-validate": null }, "contacts": { "description": "A list of contacts at the location", "items": { "properties": { "email_address": { "example": "docs@arta.io", "type": "string", "x-struct": null, "x-validate": null }, "name": { "example": "Contact Name", "type": "string", "x-struct": null, "x-validate": null }, "phone_number": { "example": "646 828 7333", "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", "example": "US", "maxLength": 2, "minLength": 2, "required": true, "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "The postal code", "example": "11211", "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations", "example": "NY", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The title or name of the location", "example": "Gallery", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "packages": { "description": "The shipments packages are formatted as a list, however, Track shipments only support a single package. You can provide details about the package being shipped, including the object details within the package", "items": { "properties": { "depth": { "description": "The depth of the object", "example": "3", "type": "string", "x-struct": null, "x-validate": null }, "height": { "description": "The height of the object", "example": "32", "type": "string", "x-struct": null, "x-validate": null }, "objects": { "description": "A list of objects in the package", "items": { "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", "example": "US", "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", "example": "123456", "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", "example": "oil on canvas", "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", "example": true, "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", "example": "1980", "type": "string", "x-struct": null, "x-validate": null }, "creator": { "description": "The creator of the object", "example": "Bob Smithson", "type": "string", "x-struct": null, "x-validate": null }, "notes": { "description": "Any notes about the item", "example": "Artist signature in the lower left corner", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The object title", "example": "Black Rectangle", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "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", "example": "Accession ID: 823", "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", "example": "Round Smithson work", "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", "example": "painting_framed", "pattern": "^[0-9a-z_]{1,56}$", "type": "string", "x-struct": null, "x-validate": null }, "value": { "$ref": "#/components/schemas/MonetaryAmount" }, "value_currency": { "$ref": "#/components/schemas/Currency" } }, "required": [ "type", "value" ], "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": { "example": "no_packing", "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", "example": "US", "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", "example": "123456", "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", "example": "oil on canvas", "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", "example": true, "type": "boolean", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "depth": { "description": "The depth of the object", "example": "3", "type": "string", "x-struct": null, "x-validate": null }, "details": { "properties": { "creation_date": { "description": "Details about the timing in which an object was created", "example": "1980", "type": "string", "x-struct": null, "x-validate": null }, "creator": { "description": "The creator of the object", "example": "Bob Smithson", "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": { "example": "canvas", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "notes": { "description": "Any notes about the item", "example": "Artist signature in the lower left corner", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The object title", "example": "Black Rectangle", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "height": { "description": "The height of the object", "example": "32", "type": "string", "x-struct": null, "x-validate": null }, "images": { "description": "A list image urls of the object", "items": { "example": "http://example.com/image.jpg", "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", "example": "Accession ID: 823", "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", "example": "Round Smithson work", "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", "example": "painting_unframed", "pattern": "^[0-9a-z_]{1,56}$", "type": "string", "x-struct": null, "x-validate": null }, "unit_of_measurement": { "enum": [ "in", "cm" ], "example": "in", "type": "string", "x-struct": null, "x-validate": null }, "value": { "$ref": "#/components/schemas/MonetaryAmount" }, "value_currency": { "$ref": "#/components/schemas/Currency" }, "weight": { "description": "The weight of the object", "example": "3.0", "type": "string", "x-struct": null, "x-validate": null }, "weight_unit": { "description": "The unit of the object", "enum": [ "lb", "kg" ], "example": "lb", "type": "string", "x-struct": null, "x-validate": null }, "width": { "description": "The width of the object", "example": "15", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "packing_materials": { "description": "The id of a material.", "items": { "example": "cardboard", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "unit_of_measurement": { "enum": [ "in", "cm" ], "example": "in", "type": "string", "x-struct": null, "x-validate": null }, "weight": { "description": "The weight of the object", "example": "3.0", "type": "string", "x-struct": null, "x-validate": null }, "weight_unit": { "description": "The unit of the object", "enum": [ "lb", "kg" ], "example": "lb", "type": "string", "x-struct": null, "x-validate": null }, "width": { "description": "The width of the object", "example": "15", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "public_reference": { "description": "A client defined name for the request. The value provided for the public_reference field may appear in notification emails and shipment detail pages", "example": "Order #1437", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "shipping_notes": { "description": "This field can be used to provide Arta any additional context about the shipment", "example": "New customer", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "tags": { "description": "A list of tags to associate with this shipment", "items": { "description": "The name of an active tag belonging to your organization.", "example": "vip", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "tracking": { "description": "The tracking details for a shipment purchased off of the Arta platform. This information should come from a commercial carrier such as DHL, FedEx, or UPS. Exactly one item is required", "items": { "properties": { "carrier": { "description": "The id of a supported commercial carrier. These can be obtained via the GET /metadata/commercial_carriers endpoint", "example": "ups", "type": "string", "x-struct": null, "x-validate": null }, "tracking_number": { "description": "The tracking number of the shipment provided by the commercial carrier", "example": "1ZXXXXXXXXXXXXXXXX", "type": "string", "x-struct": null, "x-validate": null }, "url": { "description": "The url that links to the tracking page on the commercial carrier's website", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "carrier", "tracking_number" ], "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "tracking" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "shipment" ], "title": "TrackShipmentPayload", "type": "object", "x-struct": null, "x-validate": null }, "AttachmentCreate": { "additionalProperties": false, "example": { "attachment": { "request_id": "506d79b6-1e5e-4e8c-a266-74658fdaf4ee", "upload_id": 4791 } }, "properties": { "attachment": { "properties": { "request_id": { "description": "The string ID of the request resource being associated to an upload. Do not include a request_id in the attachment parameters if you are associating a shipment", "example": "506d79b6-1e5e-4e8c-a266-74658fdaf4ee", "type": "string", "x-struct": null, "x-validate": null }, "shipment_id": { "description": "The string ID of the shipment resource being associated to an upload. Do not include a shipment_id in the attachment parameters if you are associating a shipment", "type": "string", "x-struct": null, "x-validate": null }, "upload_id": { "description": "The integer ID of the upload resource being attached", "example": 4791, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "upload_id" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "attachment" ], "title": "AttachmentCreate", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.AttachmentCreate", "x-validate": null }, "ShipmentExceptionUpdate": { "example": { "shipment_exception": { "hold_until": "2023-08-15", "status": "resolved" } }, "properties": { "shipment_exception": { "properties": { "hold_until": { "description": "Optionally provide a date to hold collection for the shipment. Values should be in the `YYYY-MM-DD` format. Hold until dates must be fewer than 30 days from the shipment's `created_at` datetime.", "type": "string", "x-struct": null, "x-validate": null }, "status": { "description": "The current status for this exception", "example": "resolved", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "shipment_exception" ], "title": "ShipmentExceptionUpdate", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.ShipmentExceptionUpdate", "x-validate": null }, "MetadataReferenceRateProvider": { "example": [ { "id": "arta", "name": "Arta" }, { "id": "dhl_express", "name": "DHL Express" }, { "id": "fedex", "name": "FedEx" }, { "id": "ups", "name": "UPS" }, { "id": "usps", "name": "USPS" } ], "items": { "properties": { "id": { "description": "The ID representing the carrier", "example": "dhl_express", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "A brief label for the carrier", "example": "DHL Express", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "title": "MetadataReferenceRateProvider", "type": "array", "x-struct": "Elixir.DocsWeb.Schemas.Response.Metadata.ReferenceRateProvider", "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", "example": "US", "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", "example": "123456", "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", "example": "oil on canvas", "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", "example": true, "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", "example": "1980", "type": "string", "x-struct": null, "x-validate": null }, "creator": { "description": "The creator of the object", "example": "Bob Smithson", "type": "string", "x-struct": null, "x-validate": null }, "notes": { "description": "Any notes about the item", "example": "Artist signature in the lower left corner", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The object title", "example": "Black Rectangle", "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", "example": "Accession ID: 823", "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", "example": "Round Smithson work", "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", "example": "painting_framed", "pattern": "^[0-9a-z_]{1,56}$", "type": "string", "x-struct": null, "x-validate": null }, "value": { "$ref": "#/components/schemas/MonetaryAmount" }, "value_currency": { "$ref": "#/components/schemas/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": { "example": "no_packing", "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", "example": "US", "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", "example": "123456", "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", "example": "oil on canvas", "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", "example": true, "type": "boolean", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "depth": { "description": "The depth of the object", "example": "3", "type": "string", "x-struct": null, "x-validate": null }, "details": { "properties": { "creation_date": { "description": "Details about the timing in which an object was created", "example": "1980", "type": "string", "x-struct": null, "x-validate": null }, "creator": { "description": "The creator of the object", "example": "Bob Smithson", "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": { "example": "canvas", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "notes": { "description": "Any notes about the item", "example": "Artist signature in the lower left corner", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The object title", "example": "Black Rectangle", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "height": { "description": "The height of the object", "example": "32", "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": { "example": "http://example.com/image.jpg", "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", "example": "Accession ID: 823", "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", "example": "Round Smithson work", "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", "example": "painting_unframed", "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" ], "example": "in", "type": "string", "x-struct": null, "x-validate": null }, "value": { "$ref": "#/components/schemas/MonetaryAmount" }, "value_currency": { "$ref": "#/components/schemas/Currency" }, "weight": { "description": "The weight of the object", "example": "3.0", "type": "string", "x-struct": null, "x-validate": null }, "weight_unit": { "description": "The unit of the object", "enum": [ "lb", "kg" ], "example": "lb", "type": "string", "x-struct": null, "x-validate": null }, "width": { "description": "The width of the object", "example": "15", "type": "string", "x-struct": null, "x-validate": null } }, "title": "Object", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.Object", "x-validate": null }, "MetadataParcelTransportService": { "items": { "properties": { "description": { "description": "A long form description", "example": "Delivers the following business day once shipped. Available in the contiguous US and Puerto Rico.", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The ID representing the resource", "example": "next_day_air", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "A brief title for the resource", "example": "Next Day Air", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "title": "MetadataParcelTransportService", "type": "array", "x-struct": "Elixir.DocsWeb.Schemas.Response.Metadata.ParcelTransportService", "x-validate": null }, "MetadataApiVersion": { "items": { "properties": { "authentication": { "description": "The list of authentication schema supported by this API version", "items": { "example": "api_key", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "description": { "description": "A long form description", "example": "A key-authenticated API Version released on October 22, 2020.", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The ID representing the resource", "example": "2020-10-22", "type": "string", "x-struct": null, "x-validate": null }, "status": { "description": "Indicates whether the API version is active, beta, or deprecated", "example": "active", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "title": "MetadataApiVersion", "type": "array", "x-struct": "Elixir.DocsWeb.Schemas.Response.Metadata.ApiVersion", "x-validate": null }, "NotFound": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null }, "ImportCostEstimateCreate": { "oneOf": [ { "additionalProperties": false, "description": "Create an import cost estimate by providing origin, destination, objects, and transport details directly", "example": { "import_cost_estimate": { "currency": "USD", "destination": { "country": "CA", "region": "ON" }, "objects": [ { "hs_code": "691390", "reference": "ceramic-vase-maria-lundqvist", "value": "10869.45" } ], "origin": { "country": "US" }, "transport": { "amount": "20000", "service_level": "ups_expedited" } } }, "properties": { "import_cost_estimate": { "properties": { "currency": { "default": "USD", "description": "ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint", "example": "USD", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "title": "Currency", "type": "string", "x-struct": null, "x-validate": null }, "destination": { "description": "Details about the destination where it will be imported to", "properties": { "city": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "country": { "description": "ISO 3166-1 alpha-2 country code of the destination", "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "State, province, or region of the destination. May be required depending on the destination country.", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "country" ], "type": "object", "x-struct": null, "x-validate": null }, "end_use": { "description": "Optional field specifying the end use of the goods", "enum": [ "for_resale", "not_for_resale" ], "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "objects": { "description": "List of objects/items being imported", "items": { "properties": { "country_of_origin": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "hs_code": { "description": "Harmonized System (HS) tariff code for the object", "type": "string", "x-struct": null, "x-validate": null }, "quantity": { "description": "Quantity of the object", "nullable": true, "type": "number", "x-struct": null, "x-validate": null }, "reference": { "description": "Reference identifier for the object", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "value": { "description": "Declared value of the object", "type": "string", "x-struct": null, "x-validate": null }, "value_currency": { "description": "Currency code (ISO 4217) used for the object's declared value", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "hs_code", "value", "value_currency" ], "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "origin": { "properties": { "country": { "description": "ISO 3166-1 alpha-2 country code of the origin", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "country" ], "type": "object", "x-struct": null, "x-validate": null }, "reference": { "description": "Optional reference string for identifying the estimate in your systems", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "transport": { "description": "Information about the transport method and cost", "properties": { "amount": { "description": "Total transport cost", "type": "string", "x-struct": null, "x-validate": null }, "amount_currency": { "description": "Currency code (ISO 4217) for the transport amount (optional)", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "service_level": { "description": "Service level for transport (e.g., ups_expedited, fedex_international_first etc). Options are listed in the reference rate service levels metadata endpoint", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "amount", "amount_currency", "service_level" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "destination", "origin", "objects", "transport" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "import_cost_estimate" ], "title": "DirectImportCostEstimatePayload", "type": "object", "x-struct": null, "x-validate": null }, { "additionalProperties": false, "description": "Create an import cost estimate from an existing quote. The quote provides transport, origin/destination, and object data. Objects on the quote's request must include hs_code for the estimate to be created.", "example": { "import_cost_estimate": { "quote_id": 1234 } }, "properties": { "import_cost_estimate": { "properties": { "currency": { "default": "USD", "description": "ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint", "example": "USD", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "title": "Currency", "type": "string", "x-struct": null, "x-validate": null }, "end_use": { "description": "Optional field specifying the end use of the goods", "enum": [ "for_resale", "not_for_resale" ], "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "quote_id": { "description": "The ID of an existing quote to derive the import cost estimate from", "format": "int64", "type": "integer", "x-struct": null, "x-validate": null }, "reference": { "description": "Optional reference string for identifying the estimate in your systems", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "quote_id" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "import_cost_estimate" ], "title": "ImportCostEstimateFromQuotePayload", "type": "object", "x-struct": null, "x-validate": null } ], "title": "ImportCostEstimateCreate", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.ImportCostEstimateCreate", "x-validate": null }, "MonetaryAmount": { "example": "2500.00", "pattern": "^(0|([1-9]+[0-9]*))(\\.[0-9]{1,2})?$", "title": "MonetaryAmount", "type": "string", "x-struct": null, "x-validate": null }, "MetadataRequestStatus": { "items": { "properties": { "description": { "description": "A long form description", "example": "Eligible shipment quotes have been added to the request", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The ID representing the resource", "example": "quoted", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "A brief title for the resource", "example": "Quoted", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "title": "MetadataRequestStatus", "type": "array", "x-struct": "Elixir.DocsWeb.Schemas.Response.Metadata.RequestStatus", "x-validate": null }, "MetadataPackageStatus": { "items": { "properties": { "description": { "description": "A long form description", "example": "Item has shipped from originating and is en route to its destination", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The ID representing this status", "example": "transit", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "A brief title for the resource", "example": "Transit", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "title": "MetadataPackageStatus", "type": "array", "x-struct": "Elixir.DocsWeb.Schemas.Response.Metadata.PackageStatus", "x-validate": null }, "ShipmentList": { "example": { "created_at": "2021-01-21T21:00:58.403150", "destination": { "city": "Los Angeles", "country": "US", "postal_code": "90024", "region": "CA" }, "hosted_session_id": null, "id": "748dd2cd-f299-446d-8e6e-19b33aa72a83", "internal_reference": "cart #425123; user #871", "object_count": 1, "origin": { "city": "Brooklyn", "country": "US", "postal_code": "11211", "region": "NY" }, "package_count": 1, "public_reference": null, "quote_type": "parcel", "shortcode": "DEMO-572652", "status": "pending", "tags": [], "total": "405.53", "total_currency": "USD", "updated_at": "2021-01-21T21:00:58.403150" }, "properties": { "created_at": { "description": "A NaiveDatetime-formatted timestamp describing when the resource was created with microsecond precision", "example": "2024-08-13T22:44:39.593704", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "destination": { "$ref": "#/components/schemas/MinimalLocation" }, "hosted_session_id": { "description": "The ID of the HostedSession through which this shipment was created", "example": 4215, "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "id": { "description": "The id of the shipment 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 character data that you may want returned unaltered for your own later usage", "example": "cart #425123; user #871", "maxLength": 255, "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "object_count": { "description": "The count of objects in this shipment", "example": 1, "format": "int64", "type": "integer", "x-struct": null, "x-validate": null }, "origin": { "$ref": "#/components/schemas/MinimalLocation" }, "package_count": { "description": "The number of packages in this shipment", "example": 1, "format": "int64", "type": "integer", "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", "example": "Order #5681", "maxLength": 255, "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "quote_type": { "description": "The ID of the quote type associated with this shipment", "enum": [ "premium", "select", "parcel", "self_ship" ], "example": "premium", "type": "string", "x-struct": null, "x-validate": null }, "shortcode": { "description": "A brief identifier for this shipment", "example": "DEMO-B8FIRV", "type": "string", "x-struct": null, "x-validate": null }, "status": { "description": "The status for this shipment", "enum": [ "pending", "confirmed", "collected", "in_transit", "completed", "cancelled" ], "example": "pending", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "tags": { "description": "A list of tags associated with the shipment", "items": { "$ref": "#/components/schemas/Tag" }, "type": "array", "x-struct": null, "x-validate": null }, "total": { "$ref": "#/components/schemas/MonetaryAmount" }, "total_currency": { "$ref": "#/components/schemas/Currency" }, "updated_at": { "description": "A NaiveDatetime-formatted timestamp describing when the resource was last updated with microsecond precision", "example": "2024-08-13T22:44:39.593704", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "ShipmentList", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.ShipmentList", "x-validate": null }, "EmailRule": { "properties": { "created_at": { "example": "2021-10-27T16:48:38.657228", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "email_notification_id": { "example": "complete", "type": "string", "x-struct": null, "x-validate": null }, "id": { "example": 1942, "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "recipients": { "example": [ "destination" ], "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "updated_at": { "example": "2021-10-27T16:48:38.657228", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null } }, "title": "EmailRule", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.EmailRule", "x-validate": null }, "MetadataShipmentExceptionType": { "example": [ { "can_create": false, "category": "Alert", "id": "change_of_address_request", "name": "Change of Address Request", "resolutions": [ "Updated without cost changes", "Updated with additional costs", "Address could not be changed", "Returned to Sender" ] }, { "can_create": false, "category": "Action Required", "id": "customs_information_required", "name": "Customs Information Required", "resolutions": [ "EEI Form Submitted" ] }, { "can_create": false, "category": "Alert", "id": "damaged_items", "name": "Damaged Items", "resolutions": [ "Repair", "Total Loss", "Partial Loss" ] }, { "can_create": false, "category": "Action Required", "id": "direct_payment_required", "name": "Direct Payment Required", "resolutions": [ "Balance Cleared" ] }, { "can_create": false, "category": "Action Required", "id": "held_at_customs", "name": "Held at Customs", "resolutions": [ "Cleared Customs", "Returned to Sender" ] }, { "can_create": false, "category": "Action Required", "id": "inaccurate_object_details", "name": "Inaccurate Object Details", "resolutions": [ "Updated without cost changes", "Updated with additional costs" ] }, { "can_create": false, "category": "Action Required", "id": "incorrect_address", "name": "Incorrect Address", "resolutions": [ "Origin Location Updated w/o Cost Changes", "Origin Location Updated w/ Additional Costs", "Destination Location Updated w/o Cost Changes", "Destination Location Updated w/ Additional Costs" ] }, { "can_create": false, "category": "Shipment Hold", "id": "label_hold", "name": "Label Hold", "resolutions": [ "Cancelled Shipment", "Labels Released" ] }, { "can_create": false, "category": "Alert", "id": "lost_in_transit", "name": "Lost in Transit", "resolutions": [ "Found", "Permanently Lost" ] }, { "can_create": false, "category": "Action Required", "id": "not_ready_for_delivery", "name": "Not Ready for Delivery", "resolutions": [ "Delivery Rescheduled", "Returned to Sender" ] }, { "can_create": false, "category": "Action Required", "id": "not_ready_for_release", "name": "Not Ready for Release", "resolutions": [ "Collection Rescheduled" ] }, { "can_create": false, "category": "Alert", "id": "other", "name": "Other", "resolutions": [] }, { "can_create": false, "category": "Action Required", "id": "prepayment_required", "name": "Prepayment Required", "resolutions": [ "Balance Cleared" ] }, { "can_create": true, "category": "Shipment Hold", "id": "requested_hold_to_collect", "name": "Requested Hold to Collect", "resolutions": [ "Collection Rescheduled" ] }, { "can_create": false, "category": "Shipment Hold", "id": "requested_hold_to_deliver", "name": "Requested Hold to Deliver", "resolutions": [ "Delivery Rescheduled", "Returned to Sender" ] }, { "can_create": false, "category": "Alert", "id": "wrong_item", "name": "Wrong Item", "resolutions": [ "Correct Items Delivered" ] } ], "items": { "properties": { "can_create": { "description": "Defines whether or not shipment exceptions of this type may be created by API clients", "type": "boolean", "x-struct": null, "x-validate": null }, "category": { "description": "The category this shipment exception type belongs to", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The ID of the shipment exception type", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "The name of the shipment exception type", "type": "string", "x-struct": null, "x-validate": null }, "resolutions": { "description": "A list of strings representing accepted resolutions for shipment exceptions of this type", "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "title": "MetadataShipmentExceptionType", "type": "array", "x-struct": "Elixir.DocsWeb.Schemas.Response.Metadata.ShipmentExceptionType", "x-validate": null }, "RequestCreate": { "description": "Create a new request", "properties": { "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, meaning this may disqualify certain segments of shipping services we offer.", "items": { "description": "The id of a service.", "example": "origin_condition_check", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "currency": { "default": "USD", "description": "The currency that the quote should be returned in. Formatted as ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint", "example": "USD", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "type": "string", "x-struct": null, "x-validate": null }, "customs_end_use": { "default": "not_for_resale", "description": "The intended end use of the items being shipped for customs purposes", "enum": [ "for_resale", "not_for_resale" ], "example": "not_for_resale", "type": "string", "x-struct": null, "x-validate": null }, "customs_process": { "default": "ddu", "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" ], "example": "ddu", "type": "string", "x-struct": null, "x-validate": null }, "destination": { "description": "The destination location for the quote request", "properties": { "access_restrictions": { "deprecated": true, "description": "A list of access restricition IDs describing physical properties for the location. Options are defined in the Location Access Restrictions metadata endpoint", "items": { "example": "stairs_only", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "address_line_1": { "description": "The first line of the location's street address", "example": "11 W 53rd St", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "The second line of the location's street address", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "address_line_3": { "description": "The third line of the location's street address", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "The name of the city for the location", "example": "New York", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "contacts": { "description": "The contact details for the location", "items": { "properties": { "email_address": { "description": "The email address for this contact", "example": "mary@example.com", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "The contact's name", "example": "Mary Quinn Sullivan", "type": "string", "x-struct": null, "x-validate": null }, "phone_number": { "description": "The phone_number for this contact", "example": "(333) 333-3333", "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 location", "example": "US", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "The postal code for the location", "example": "10019", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations", "example": "NY", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The name for the location", "example": "Gallery", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "postal_code", "country" ], "type": "object", "x-struct": null, "x-validate": null }, "insurance": { "description": "The ID of the requested Arta insurance type. Options are defined in the Insurances metadata endpoint", "example": "arta_transit_insurance", "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", "example": "Purchase Order: 2801", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "objects": { "items": { "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", "example": "US", "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", "example": "123456", "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", "example": "oil on canvas", "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", "example": true, "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", "example": "1980", "type": "string", "x-struct": null, "x-validate": null }, "creator": { "description": "The creator of the object", "example": "Bob Smithson", "type": "string", "x-struct": null, "x-validate": null }, "notes": { "description": "Any notes about the item", "example": "Artist signature in the lower left corner", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The object title", "example": "Black Rectangle", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "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", "example": "Accession ID: 823", "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", "example": "Round Smithson work", "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", "example": "painting_framed", "pattern": "^[0-9a-z_]{1,56}$", "type": "string", "x-struct": null, "x-validate": null }, "value": { "$ref": "#/components/schemas/MonetaryAmount" }, "value_currency": { "$ref": "#/components/schemas/Currency" } }, "required": [ "type", "value" ], "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": { "example": "no_packing", "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", "example": "US", "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", "example": "123456", "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", "example": "oil on canvas", "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", "example": true, "type": "boolean", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "depth": { "description": "The depth of the object", "example": "3", "type": "string", "x-struct": null, "x-validate": null }, "details": { "properties": { "creation_date": { "description": "Details about the timing in which an object was created", "example": "1980", "type": "string", "x-struct": null, "x-validate": null }, "creator": { "description": "The creator of the object", "example": "Bob Smithson", "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": { "example": "canvas", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "notes": { "description": "Any notes about the item", "example": "Artist signature in the lower left corner", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The object title", "example": "Black Rectangle", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "height": { "description": "The height of the object", "example": "32", "type": "string", "x-struct": null, "x-validate": null }, "images": { "description": "A list image urls of the object", "items": { "example": "http://example.com/image.jpg", "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", "example": "Accession ID: 823", "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", "example": "Round Smithson work", "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", "example": "painting_unframed", "pattern": "^[0-9a-z_]{1,56}$", "type": "string", "x-struct": null, "x-validate": null }, "unit_of_measurement": { "enum": [ "in", "cm" ], "example": "in", "type": "string", "x-struct": null, "x-validate": null }, "value": { "$ref": "#/components/schemas/MonetaryAmount" }, "value_currency": { "$ref": "#/components/schemas/Currency" }, "weight": { "description": "The weight of the object", "example": "3.0", "type": "string", "x-struct": null, "x-validate": null }, "weight_unit": { "description": "The unit of the object", "enum": [ "lb", "kg" ], "example": "lb", "type": "string", "x-struct": null, "x-validate": null }, "width": { "description": "The width of the object", "example": "15", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "depth", "height", "subtype", "width", "unit_of_measurement", "weight_unit", "value", "value_currency" ], "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "origin": { "description": "The originating location for the quote request", "properties": { "access_restrictions": { "deprecated": true, "description": "A list of access restricition ids describing physical properties of the location. Options are defined in the Location Access Restrictions metadata endpoint ", "items": { "example": "non_paved", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "address_line_1": { "description": "The first line of the location's street address", "example": "87 Richardson St", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "The second line of the location's street address", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "address_line_3": { "description": "The third line of the location's street address", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "The name of the city for the location", "example": "Brooklyn", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "contacts": { "description": "The contact details for the location", "items": { "properties": { "email_address": { "description": "The main email address for this contact", "example": "registrar@example.com", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "The contact's name", "example": "Rachel Egistrar", "type": "string", "x-struct": null, "x-validate": null }, "phone_number": { "description": "The main phone_number for this contact", "example": "(212) 123-4567", "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 location", "example": "US", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "The postal code for the location", "example": "11249", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations", "example": "NY", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The name for the location", "example": "Warehouse", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "postal_code", "country" ], "type": "object", "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.", "example": [ "ground" ], "items": { "type": "string", "x-struct": null, "x-validate": null }, "nullable": true, "type": "array", "x-struct": null, "x-validate": null }, "preferred_quote_types": { "description": "Optionally instruct the Arta API to return a subset of quote types for this request. For example if you would prefer to only return Select quotes for a particular request, you can set this field to `[\"select\"]` You can find all available quote type IDs at the /metadata/quotes endpoint.", "items": { "example": "parcel", "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 request. The value provided for the public_reference field may appear in notification emails and shipment detail pages", "example": "Order #1437", "maxLength": 255, "type": "string", "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" ], "example": "best_rate", "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", "example": "New customer", "type": "string", "x-struct": null, "x-validate": null }, "tags": { "description": "A list of tags to associate with this request", "items": { "description": "The name of an active tag belonging to your organization.", "example": "ny-warehouse", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "destination", "objects", "origin" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "request" ], "title": "RequestCreate", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.RequestCreate", "x-validate": null }, "ShipmentException": { "example": { "created_at": "2023-05-26T19:33:19.693833", "exception_type_label": null, "hold_until": null, "id": "d686ad3b-33fd-454c-a7aa-94b1ecbc539f", "package_id": 4366794, "resolution": null, "shipment_id": "a5cbb58c-43ab-4658-9999-98a33b0070d5", "source": "api", "status": "new", "type": "held_at_customs", "updated_at": "2023-05-26T19:33:19.693833" }, "properties": { "created_at": { "description": "A NaiveDatetime-formatted timestamp describing when the exception was created with microsecond precision", "example": "2024-08-13T22:44:39.593704", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "exception_type_label": { "description": "An additional label providing context about the exception type (optional)", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "hold_until": { "description": "The date the shipment will be held until", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The id of the exception in UUID format", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "package_id": { "description": "The package associated with this exception (optional)", "example": "12345", "format": "int64", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "resolution": { "description": "A brief description of the method by which this exception was resolved", "example": "Balance Cleared", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "shipment_id": { "description": "The id of the shipment associated with this exception", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "source": { "description": "The source of the exception", "example": "arta_team", "type": "string", "x-struct": null, "x-validate": null }, "status": { "description": "The current status for this exception", "enum": [ "new", "in_progress", "resolved" ], "example": "resolved", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "The type of exception", "example": "prepayment_required", "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "A NaiveDatetime-formatted timestamp describing when the exception was last updated with microsecond precision", "example": "2024-08-13T22:44:39.593704", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null } }, "title": "ShipmentException", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.ShipmentException", "x-validate": null }, "RequestUpdateContacts": { "example": { "destination": { "contacts": [ { "email_address": "destination@example.com", "name": "Destination Contact", "phone_number": "(310) 123-4567" } ] }, "origin": { "contacts": [ { "email_address": "origin@example.com", "name": "Origin Contact", "phone_number": "(310) 234-5678" } ] } }, "properties": { "destination": { "properties": { "contacts": { "items": { "properties": { "email_address": { "description": "The email address for this contact", "example": "destination@example.com", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "The contact's name", "example": "Destination Contact", "type": "string", "x-struct": null, "x-validate": null }, "phone_number": { "description": "The phone number for this contact", "example": "(310) 123-4567", "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 } }, "type": "object", "x-struct": null, "x-validate": null }, "origin": { "properties": { "contacts": { "items": { "properties": { "email_address": { "description": "The email address for this contact", "example": "origin@example.com", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "The contact's name", "example": "Origin Contact", "type": "string", "x-struct": null, "x-validate": null }, "phone_number": { "description": "The phone number for this contact", "example": "(310) 234-5678", "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 } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "RequestUpdateContacts", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.RequestUpdateContacts", "x-validate": null }, "OrganizationUpdate": { "additionalProperties": false, "example": { "organization": { "api_version": "2021-01-01", "company_name": "Hudson Street Collective LLC", "display_name": "Hudson Street", "name": "Hudson Street Gallery" } }, "properties": { "organization": { "properties": { "api_version": { "description": "The fallback API Version to be used as a default when API calls associated with this Organization do not include an `Arta-Version` header", "example": "2020-10-22", "type": "string", "x-struct": null, "x-validate": null }, "company_name": { "description": "The legal name for this organization; used as part of Arta's billing and invoicing processes.", "type": "string", "x-struct": null, "x-validate": null }, "display_name": { "description": "The display name for this organization. Presented on public pages for this organizations' shipments.", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "The name for this Organization.", "example": "Arta", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "organization" ], "title": "OrganizationUpdate", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.OrganizationUpdate", "x-validate": null }, "WebhookDelivery": { "properties": { "created_at": { "example": "2021-10-27T16:48:38.657228", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The string ID for this webhook delivery resource", "example": "5b6e1621-454f-4f18-aecf-87192406effe", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "next_retry": { "description": "The UTC timestamp describing when a follow up webhook delivery event will be attempted if this one has failed", "nullable": true, "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "request_body": { "description": "A stringified JSON representation of the data Arta sent to your endpoint", "example": "{\"data\":{\"id\":432672},\"object\":\"webhook\",\"type\":\"ping\"}", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "resource_id": { "description": "The ID of the resource that triggered the webhook event", "example": "9c67b26c-6b5d-4e19-a703-f7356f82d7e0", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "resource_type": { "description": "The type of resource that triggered the webhook event", "enum": [ "ping", "request", "shipment" ], "example": "request", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "response_body": { "description": "A string representation of the response body Arta received from your endpoint", "example": "{\"received\": true}", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "response_status_code": { "description": "The numerical HTTP status code Arta received from your endpoint", "example": 202, "readOnly": true, "type": "number", "x-struct": null, "x-validate": null }, "status": { "description": "The status of the webhook delivery event", "enum": [ "delivered", "failed" ], "example": "delivered", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "The type of webhook delivery sent to your endpoint", "enum": [ "ping", "request.created", "request.shared", "request.status.updated", "request.updated", "shipment.created", "shipment.eei_form_status.updated", "shipment.exceptions.updated", "shipment.schedule.updated", "shipment.status.updated", "shipment.tracking.updated", "shipment.updated", "shipment_exception.created", "shipment_exception.status.updated" ], "example": "ping", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "webhook_id": { "description": "The ID belonging to your webhook endpoint in Arta's system", "example": 432672, "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "webhook_url": { "description": "The URL belonging to your webhook endpoint in Arta's system at the time Arta attempted delivery of the webhook event", "example": "https://hooks.mydomain.xyz/arta", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null } }, "title": "WebhookDelivery", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.WebhookDelivery", "x-validate": null }, "SelfShipCollection": { "example": { "closed_at": null, "collection_date": "2026-03-06", "collection_time": "10:00:00", "created_at": "2026-03-01T12:00:00.000000", "id": "550e8400-e29b-41d4-a716-446655440000", "location": { "address_line_1": "123 Main St", "address_line_2": null, "city": "New York", "close_time": "17:00:00", "contact": { "email_address": "john@example.com", "name": "John Doe", "phone_number": "+1-555-123-4567" }, "country": "US", "package_location": "front", "postal_code": "10001", "region": "NY" }, "service": { "carrier": "fedex", "code": "express", "route": "domestic" }, "shortcode": "ACME-S3GP24", "status": "scheduled", "updated_at": "2026-03-01T12:00:00.000000" }, "properties": { "closed_at": { "description": "A NaiveDatetime-formatted timestamp describing when the collection was closed", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "collection_date": { "description": "The pickup date in ISO 8601 format (`YYYY-MM-DD`).", "example": "2026-03-06", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "collection_time": { "description": "The pickup time in ISO 8601 format (`HH:MM:SS`).", "example": "10:00:00", "type": "string", "x-struct": null, "x-validate": null }, "created_at": { "description": "A NaiveDatetime-formatted timestamp describing when the resource was created with microsecond precision", "example": "2026-03-01T12:00:00.000000", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The ID of the self-ship collection in UUID format", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "location": { "description": "The pickup location details", "properties": { "address_line_1": { "description": "Street address", "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "Additional address info", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "City", "type": "string", "x-struct": null, "x-validate": null }, "close_time": { "description": "Location closing time in ISO 8601 format (`HH:MM:SS`)", "example": "17:00:00", "type": "string", "x-struct": null, "x-validate": null }, "contact": { "description": "Contact at the pickup location", "properties": { "email_address": { "description": "Contact email address", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "Contact name", "type": "string", "x-struct": null, "x-validate": null }, "phone_number": { "description": "Contact phone number", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "country": { "description": "Two-letter country code", "example": "US", "type": "string", "x-struct": null, "x-validate": null }, "package_location": { "description": "Where packages are located at the pickup location", "enum": [ "front", "none", "rear", "side" ], "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "Postal code", "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "State or province code", "example": "NY", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "service": { "description": "Carrier service details", "properties": { "carrier": { "description": "Carrier identifier", "enum": [ "fedex" ], "type": "string", "x-struct": null, "x-validate": null }, "code": { "description": "Service level code", "enum": [ "express", "ground" ], "type": "string", "x-struct": null, "x-validate": null }, "route": { "description": "Route type", "enum": [ "domestic", "international" ], "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "shortcode": { "description": "A human-readable identifier for the collection, formatted as the organization's shortcode followed by a hyphen and six alphanumeric characters", "example": "ACME-S3GP24", "pattern": "^[A-Z]+-[A-Z0-9]{6}$", "type": "string", "x-struct": null, "x-validate": null }, "status": { "description": "The current status of the collection", "enum": [ "scheduled", "closed", "cancelled", "incomplete" ], "example": "scheduled", "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", "example": "2026-03-01T12:00:00.000000", "type": "string", "x-struct": null, "x-validate": null } }, "title": "SelfShipCollection", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.SelfShipCollection", "x-validate": null }, "UploadWithPresignedURL": { "properties": { "created_at": { "example": "2021-10-27T16:48:38.657228", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "document_type": { "description": "The document type of the uploaded file", "enum": [ "bill_of_lading", "certificate_of_insurance", "certificate_of_insurance_template", "condition_report", "condition_check", "image", "instructions", "airway_bill", "commercial_invoice", "power_of_attorney", "proof_of_export", "proof_of_delivery", "quote", "shipping_label", "other" ], "example": "other", "type": "string", "x-struct": null, "x-validate": null }, "document_type_label": { "description": "A brief label providing additional context about the `document_type`. Required when \"other\" is the `document_type`", "example": "Inventory List", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "download_url": { "example": "https://api.arta.io/downloads/kikhAFZ565BzbGooRqLZl", "nullable": true, "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "file_name": { "description": "The name of the uploaded file", "example": "inventory_list_27148_16.pdf", "type": "string", "x-struct": null, "x-validate": null }, "id": { "example": 1942, "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "mime_type": { "description": "The mime-type of the uploaded file", "enum": [ "application/pdf", "application/vnd.ms-excel", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "image/jpeg", "image/png", "text/csv", "video/mp4", "video/quicktime", "application/msword" ], "example": "application/pdf", "type": "string", "x-struct": null, "x-validate": null }, "presigned_url": { "description": "A pre-signed and secure URL to use to send the file to Arta via a PUT HTTP request within 20 seconds of the upload resource being created", "example": "https://api.arta.io/downloads/35fc1956-71fc-4b1c-846b-6ea963182a8c", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "size": { "description": "The size of the uploaded file in bytes", "example": 58550, "type": "integer", "x-struct": null, "x-validate": null }, "status": { "enum": [ "pending", "processed", "failed" ], "example": "processed", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "document_type", "file_name", "mime_type", "size" ], "title": "UploadWithPresignedURL", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.UploadWithPresignedURL", "x-validate": null }, "Invoice": { "example": { "amount_owed": "276.91", "amount_owed_currency": "USD", "amount_paid": "276.91", "amount_paid_currency": "USD", "created_at": "2021-03-10T20:15:34.096258", "id": 2216, "invoice_url": null, "issued_on": "2021-03-10", "shipment_id": "53d6bdec-1eae-46e2-97c2-3e56b1a1095d", "status": "closed", "updated_at": "2021-03-10T20:16:10.202836" }, "properties": { "amount_owed": { "type": "string", "x-struct": null, "x-validate": null }, "amount_owed_currency": { "type": "string", "x-struct": null, "x-validate": null }, "amount_paid": { "type": "string", "x-struct": null, "x-validate": null }, "amount_paid_currency": { "type": "string", "x-struct": null, "x-validate": null }, "created_at": { "type": "string", "x-struct": null, "x-validate": null }, "id": { "type": "integer", "x-struct": null, "x-validate": null }, "invoice_url": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "issued_on": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "shipment_id": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "status": { "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "type": "string", "x-struct": null, "x-validate": null } }, "title": "Invoice", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.Invoice", "x-validate": null }, "SelfShipCollectionAvailabilityCheck": { "example": { "availabilities": [ { "collection_date": "2026-03-06", "collection_times": [ "07:00:00", "07:30:00", "08:00:00" ], "residential_available": true } ], "collection_date": "2026-03-06", "location": { "address_line_1": "123 Main St", "city": "New York", "close_time": "17:00:00", "country": "US", "postal_code": "10001", "region": "NY" }, "service": { "carrier": "fedex", "code": "ground", "route": "domestic" } }, "properties": { "availabilities": { "description": "Available pickup slots. May be empty if no slots are available.", "items": { "properties": { "collection_date": { "description": "Available pickup date (`YYYY-MM-DD`)", "example": "2026-03-06", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "collection_times": { "description": "Available pickup times in ISO 8601 format (`HH:MM:SS`)", "items": { "example": "07:00:00", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "residential_available": { "description": "Whether residential pickup is available", "type": "boolean", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "collection_date": { "description": "The date that was checked for availability (`YYYY-MM-DD`)", "example": "2026-03-06", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "location": { "description": "The pickup location that was checked", "properties": { "address_line_1": { "description": "Street address", "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "Additional address info", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "City", "type": "string", "x-struct": null, "x-validate": null }, "close_time": { "description": "Location closing time in ISO 8601 format (`HH:MM:SS`)", "example": "17:00:00", "type": "string", "x-struct": null, "x-validate": null }, "country": { "description": "Two-letter country code", "example": "US", "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "Postal code", "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "State or province code", "example": "NY", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "service": { "description": "The carrier service that was checked", "properties": { "carrier": { "description": "Carrier identifier", "enum": [ "fedex" ], "type": "string", "x-struct": null, "x-validate": null }, "code": { "description": "Service level code", "enum": [ "ground", "express" ], "type": "string", "x-struct": null, "x-validate": null }, "route": { "description": "Route type", "enum": [ "domestic", "international" ], "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "SelfShipCollectionAvailabilityCheck", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.SelfShipCollectionAvailabilityCheck", "x-validate": null }, "TagCreate": { "additionalProperties": false, "properties": { "tag": { "properties": { "color": { "description": "The hexadecimal color code for the tag, without the leading `#`.", "example": "0000FF", "maxLength": 6, "minLength": 6, "pattern": "^[0-9A-F]{6}$", "type": "string", "x-struct": null, "x-validate": null }, "description": { "description": "An optional, brief description for this tag.", "maxLength": 255, "nullable": true, "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", "nullable": true, "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.", "example": "la-warehouse", "maxLength": 50, "pattern": "^[a-z0-9-]{1,50}$", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "color", "name" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "tag" ], "title": "TagCreate", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.TagCreate", "x-validate": null }, "Organization": { "example": { "api_version": "2021-01-01", "billing_terms": "invoicing", "company_name": "Hudson Street Collective LLC", "created_at": "2022-10-23T13:39:12.504731", "display_name": "Hudson Street", "id": 4392, "name": "Hudson Street Gallery", "shortcode": "HSC", "status": "active", "updated_at": "2023-05-02T23:13:31.193097" }, "properties": { "api_version": { "type": "string", "x-struct": null, "x-validate": null }, "billing_terms": { "type": "string", "x-struct": null, "x-validate": null }, "company_name": { "type": "string", "x-struct": null, "x-validate": null }, "created_at": { "type": "string", "x-struct": null, "x-validate": null }, "display_name": { "type": "string", "x-struct": null, "x-validate": null }, "id": { "format": "int64", "type": "integer", "x-struct": null, "x-validate": null }, "name": { "type": "string", "x-struct": null, "x-validate": null }, "shortcode": { "type": "string", "x-struct": null, "x-validate": null }, "status": { "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "type": "string", "x-struct": null, "x-validate": null } }, "title": "Organization", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.Organization", "x-validate": null }, "WebhookSecretToken": { "properties": { "secret_token": { "description": "The secret token associated with the webhook endpoint", "example": "zASePCHfe2FYKjXl1YhFukNY5T7hCqgX0RRBUVi_289ubnhBvN9U03uOqG8oB2Oz", "type": "string", "x-struct": null, "x-validate": null } }, "title": "WebhookSecretToken", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.WebhookSecretToken", "x-validate": null }, "MetadataQuotingStrategy": { "items": { "properties": { "description": { "description": "A long form description", "example": "Returns the lowest-cost option per transport service. This strategy is ideal when cost efficiency is the priority and carrier choice is not a concern.", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The ID representing the resource", "example": "best_rate", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "A brief title for the resource", "example": "Best Rate", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "title": "MetadataQuotingStrategy", "type": "array", "x-struct": "Elixir.DocsWeb.Schemas.Response.Metadata.QuotingStrategy", "x-validate": null }, "EmailRuleUpdate": { "additionalProperties": false, "properties": { "email_rule": { "properties": { "recipients": { "description": "The list of recipients for this Email Rule.", "example": [ "destination", "origin" ], "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "recipients" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "email_rule" ], "title": "EmailRuleUpdate", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.EmailRuleUpdate", "x-validate": null }, "HostedSessionListItem": { "example": { "additional_services": [ "signature_delivery" ], "can_user_confirm_object_dimensions": false, "cancel_url": "http://example.com/cancel", "created_at": "2021-01-21T17:22:08.818747", "destination": null, "id": 42, "insurance": null, "internal_reference": null, "objects": [ { "components": [ { "customs": { "country_of_origin": "US", "hs_code": "123456", "medium": "oil on canvas", "temporary_admission": true }, "details": { "creation_date": "1980", "creator": "Bob Smithson", "notes": "Artist signature in the lower left corner", "title": "Black Rectangle" }, "id": "1f26b6e1-ce25-43a9-b4ea-2ceaac24ec3a", "internal_reference": "Accession ID: 823", "public_reference": "Round Smithson work", "type": "painting_framed", "value": "15000", "value_currency": "USD" } ], "current_packing": [ "cardboard_box" ], "depth": "2", "details": { "creation_date": null, "creator": null, "is_cites": false, "is_fragile": false, "materials": [], "notes": null, "title": null }, "height": "10.5", "id": 12346, "images": [], "internal_reference": null, "public_reference": null, "subtype": "prepacked_box", "type": "client_package", "unit_of_measurement": "in", "value": "15000", "value_currency": "USD", "weight": "3.5", "weight_unit": "lb", "width": "10" }, { "components": [], "current_packing": [], "customs": { "country_of_origin": "US", "hs_code": "123456", "medium": "oil on canvas", "temporary_admission": true }, "depth": "2", "details": { "creation_date": null, "creator": "Robert Irwin", "is_cites": false, "is_fragile": false, "materials": [], "notes": "notes", "title": "It's just jazz" }, "height": "24", "id": 12345, "images": [], "internal_reference": null, "public_reference": null, "subtype": "painting_unframed", "type": "art", "unit_of_measurement": "in", "value": "100.00", "value_currency": "USD", "weight": "1", "weight_unit": "lb", "width": "36" } ], "origin": { "access_restrictions": [], "address_line_1": "11 W 53rd St", "address_line_2": null, "address_line_3": null, "city": "New York", "contacts": [ { "email_address": "mary@example.com", "name": "Mary Quinn Sullivan", "phone_number": "(333) 333-3333" } ], "country": "US", "postal_code": "10019", "region": "NY", "title": "Warehouse" }, "payment_process": "invoicing", "preferred_quote_types": [], "private_token": "6f76b6e1-ce25-43a9-b4ea-2ceaac24ec7e", "public_reference": null, "quoting_strategy": "best_rate", "shipping_notes": null, "shortcode": "DEMO-BA9SVZ", "status": "new", "success_url": "http://example.com/success", "tags": [], "type": "booking", "updated_at": "2021-01-21T17:22:10.129653", "url": "https://book.arta.io/b/42/6f76b6e1-ce25-43a9-b4ea-2ceaac24ec7e" }, "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 }, "can_user_confirm_object_dimensions": { "description": "Determines whether your customer can verify and update object dimension information when completing an inbound booking session.", "type": "boolean", "x-struct": null, "x-validate": null }, "cancel_url": { "description": "The URL the user will be redirected to after an Arta Booking session is cancelled", "type": "string", "x-struct": null, "x-validate": null }, "created_at": { "type": "string", "x-struct": null, "x-validate": null }, "destination": { "$ref": "#/components/schemas/NullableLocation" }, "id": { "format": "int64", "type": "integer", "x-struct": null, "x-validate": null }, "insurance": { "description": "The id of an insurance type. If requesting Arta insurance, object values must be provided.", "example": "arta_transit_insurance", "nullable": true, "type": "string", "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, "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "objects": { "description": "A list of objects to be shipped", "items": { "$ref": "#/components/schemas/Object" }, "type": "array", "x-struct": null, "x-validate": null }, "origin": { "$ref": "#/components/schemas/Location" }, "payment_process": { "description": "The primary method by which payment to Arta will be handled for any shipment booked through this hosted session", "enum": [ "checkout", "invoicing" ], "example": "checkout", "readOnly": true, "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.", "example": [ "ground" ], "items": { "type": "string", "x-struct": null, "x-validate": null }, "nullable": true, "type": "array", "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 hosted session", "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "private_token": { "description": "A private access token for this resource. It is used to generate the private URL for the hosted session", "type": "string", "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, "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "quoting_strategy": { "default": "best_rate", "description": "The quoting strategy used when creating quote requests for this booking session. Determines whether the API returns a single best-rate option per transport speed or multiple carrier options for comparison", "enum": [ "best_rate", "compare_carriers" ], "example": "best_rate", "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", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "shortcode": { "description": "A brief and unique string identifier for the resource", "example": "DEMO-B8FIRV", "type": "string", "x-struct": null, "x-validate": null }, "status": { "example": "quoted", "type": "string", "x-struct": null, "x-validate": null }, "success_url": { "description": "The URL the user will be redirected to after an Arta Booking session is completed", "type": "string", "x-struct": null, "x-validate": null }, "tags": { "description": "A list of tags associated with this hosted session", "items": { "$ref": "#/components/schemas/Tag" }, "type": "array", "x-struct": null, "x-validate": null }, "type": { "description": "The type of the hosted session", "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "type": "string", "x-struct": null, "x-validate": null }, "url": { "description": "The Arta Booking web URL for this Hosted Session", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "title": "HostedSessionListItem", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.HostedSessionListItem", "x-validate": null }, "MetadataCommercialCarrier": { "example": [ { "id": "dhl_express", "name": "DHL Express" }, { "id": "fedex", "name": "FedEx" }, { "id": "ups", "name": "UPS" }, { "id": "usps", "name": "USPS" } ], "items": { "properties": { "id": { "description": "The ID representing the carrier", "example": "dhl_express", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "A brief label for the carrier", "example": "DHL Express", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "title": "MetadataCommercialCarrier", "type": "array", "x-struct": "Elixir.DocsWeb.Schemas.Response.Metadata.CommercialCarrier", "x-validate": null }, "UploadCreate": { "additionalProperties": false, "properties": { "upload": { "properties": { "document_type": { "description": "The document type of the file being uploaded", "enum": [ "bill_of_lading", "certificate_of_insurance", "certificate_of_insurance_template", "condition_report", "condition_check", "image", "instructions", "airway_bill", "commercial_invoice", "power_of_attorney", "proof_of_export", "proof_of_delivery", "quote", "shipping_label", "other" ], "type": "string", "x-struct": null, "x-validate": null }, "document_type_label": { "description": "A brief label providing additional context about the document_type. Required when \"other\" is the \"document_type\"", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "file_name": { "description": "The name of the file being uploaded", "example": "my-file.csv", "type": "string", "x-struct": null, "x-validate": null }, "mime_type": { "description": "The mime-type for the file being uploaded", "enum": [ "application/pdf", "application/vnd.ms-excel", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "image/jpeg", "image/png", "text/csv", "video/mp4", "video/quicktime", "application/msword" ], "example": "text/csv", "type": "string", "x-struct": null, "x-validate": null }, "size": { "description": "The size of the file being uploaded in bytes", "example": 22, "type": "integer", "x-struct": null, "x-validate": null } }, "required": [ "document_type", "file_name", "mime_type", "size" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "upload" ], "title": "UploadCreate", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.UploadCreate", "x-validate": null }, "RequestListItem": { "example": { "bookable": { "missing": [], "ready": true }, "created_at": "2021-01-21T21:00:29.568665", "destination": { "city": "New York", "country": "US", "postal_code": "11249", "region": "NY" }, "hosted_session_id": 724, "id": "6b12c76a-5217-4cd6-82d8-7aa5265ebaad", "insurance": null, "internal_reference": null, "object_count": 1, "origin": { "city": "New York", "country": "US", "postal_code": "10019", "region": "NY" }, "public_reference": null, "quote_types": [ "parcel", "select", "premium" ], "quoting_strategy": "best_rate", "shortcode": "DEMO-R29NAW", "status": "closed", "tags": [], "updated_at": "2021-01-21T21:00:58.484566" }, "properties": { "bookable": { "description": "Communicates whether the quotes generated for this request may be booked into shipments", "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": { "default": true, "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 ", "example": "2021-01-21T21:00:58.403150", "type": "string", "x-struct": null, "x-validate": null }, "destination": { "additionalProperties": false, "description": "A minimal representation of the destination address for the request", "properties": { "city": { "description": "The destination address city", "example": "Los Angeles", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "country": { "description": "The destination address country in 2-digit ISO 3166-1 alpha-2 format", "example": "US", "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "The destination address postal code", "example": "90024", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "The destination address region", "example": "CA", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "hosted_session_id": { "description": "The ID of the HostedSession through which this request was created\n\n", "example": 4215, "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "id": { "description": "The ID for this request", "example": "748dd2cd-f299-446d-8e6e-19b33aa72a83", "type": "string", "x-struct": null, "x-validate": null }, "insurance": { "description": "This field can be used to pass through any character data that you may want returned unaltered for your own later usage", "enum": [ null, "arta_transit_insurance" ], "example": "arta_transit_insurance", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "internal_reference": { "description": "This field can be used to pass through any character data that you may want returned unaltered for your own later usage", "example": "cart #425123; user #871", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "log_request_id": { "description": "An identifier for the API call that created this resource", "example": "Fv9YnUGcBW9ozqgA2s_x", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "object_count": { "description": "The count of objects in this request", "example": 1, "type": "integer", "x-struct": null, "x-validate": null }, "origin": { "description": "A minimal representation of the origin address for the request", "properties": { "city": { "description": "The origin address city", "example": "Brooklyn", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "country": { "description": "The origin address country in 2-digit ISO 3166-1 alpha-2 format", "example": "US", "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "The origin address postal code", "example": "11211", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "The origin address region", "example": "NY", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "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", "example": "Order #56812", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "quote_types": { "description": "The IDs of the quote types generated for this request", "items": { "enum": [ "parcel", "premium", "select", "self_ship" ], "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "quoting_strategy": { "description": "TThe 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" ], "example": "best_rate", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "shortcode": { "description": "A brief string identifier for this shipment", "example": "DEMO-R723LA", "type": "string", "x-struct": null, "x-validate": null }, "status": { "description": "The status for this shipment", "enum": [ "quoted", "in_progress", "closed", "disqualified", "expired", "cancelled", "pending" ], "example": "quoted", "type": "string", "x-struct": null, "x-validate": null }, "tags": { "description": "A list of tags associated with this request", "items": { "$ref": "#/components/schemas/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 ", "example": "2021-01-21T21:00:58.403150", "type": "string", "x-struct": null, "x-validate": null } }, "title": "RequestListItem", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.RequestListItem", "x-validate": null }, "RequestUpdateCustom": { "properties": { "note": { "description": "An optional note providing additional context for the Arta team about your custom quote request.", "type": "string", "x-struct": null, "x-validate": null } }, "title": "RequestUpdateCustom", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.RequestUpdateCustom", "x-validate": null }, "MetadataObject": { "items": { "properties": { "description": { "description": "A long form description", "example": "Works of art various media including paintings, sculpture, or works on paper.", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The ID representing the resource", "example": "art", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "A brief title for the resource", "example": "Works of art", "type": "string", "x-struct": null, "x-validate": null }, "subtypes": { "description": "The subtypes for this resource", "items": { "description": "An object subtype", "properties": { "description": { "description": "A long form description", "example": "A painting that is framed behind a glass face.", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The ID representing the resource", "example": "painting_framed_glass", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "A brief title for the resource", "example": "Painting (framed with glass)", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "title": "MetadataObject", "type": "array", "x-struct": "Elixir.DocsWeb.Schemas.Response.Metadata.Object", "x-validate": null }, "ImportCostEstimateFromQuotePayload": { "additionalProperties": false, "description": "Create an import cost estimate from an existing quote. The quote provides transport, origin/destination, and object data. Objects on the quote's request must include hs_code for the estimate to be created.", "example": { "import_cost_estimate": { "quote_id": 1234 } }, "properties": { "import_cost_estimate": { "properties": { "currency": { "default": "USD", "description": "ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint", "example": "USD", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "title": "Currency", "type": "string", "x-struct": null, "x-validate": null }, "end_use": { "description": "Optional field specifying the end use of the goods", "enum": [ "for_resale", "not_for_resale" ], "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "quote_id": { "description": "The ID of an existing quote to derive the import cost estimate from", "format": "int64", "type": "integer", "x-struct": null, "x-validate": null }, "reference": { "description": "Optional reference string for identifying the estimate in your systems", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "quote_id" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "import_cost_estimate" ], "title": "ImportCostEstimateFromQuotePayload", "type": "object", "x-struct": null, "x-validate": null }, "ImportCostEstimate": { "example": { "currency": "USD", "destination": { "city": null, "country": "CA", "postal_code": null, "region": "ON" }, "end_use": "for_resale", "estimate": { "line_items": [ { "amount": "706.51", "description": "duty", "subtype": "item", "type": "duty" } ], "summary": { "ddp_service_fees": "0.00", "duties": "2119.53", "fees": "147.13", "taxes": "1754.97" } }, "id": "30e1d8e7-f175-46c7-afee-8aa16c9d988b", "objects": [ { "country_of_origin": null, "hs_code": "691390", "quantity": 1, "reference": "ceramic-vase-maria-lundqvist", "value": "10869.45", "value_currency": "USD" } ], "origin": { "country": "BR" }, "quote_id": null, "reference": null, "shortcode": "JANANI-I5Y6SR", "status": "success", "transport": { "amount": "20000.00", "amount_currency": "USD", "service_level": "ups_expedited" } }, "properties": { "currency": { "default": "USD", "description": "ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint", "example": "USD", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "title": "Currency", "type": "string", "x-struct": null, "x-validate": null }, "destination": { "description": "Details about the destination where it will be imported to", "properties": { "city": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "country": { "description": "ISO 3166-1 alpha-2 country code of the destination", "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "State, province, or region of the destination.", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "end_use": { "description": "The end use of the goods", "enum": [ "for_resale", "not_for_resale" ], "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "estimate": { "description": "Breakdown of the estimated import costs", "properties": { "line_items": { "description": "Detailed breakdown of individual charges", "items": { "properties": { "amount": { "description": "Amount of the charge in the estimate currency", "type": "string", "x-struct": null, "x-validate": null }, "description": { "description": "Description of the charge", "type": "string", "x-struct": null, "x-validate": null }, "subtype": { "description": "Subtype classification of the charge", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "Type of charge (e.g., duty, tax, fee)", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "summary": { "description": "Summary totals of the import cost estimate", "properties": { "ddp_service_fees": { "description": "Total DDP service fees amount", "type": "string", "x-struct": null, "x-validate": null }, "duties": { "description": "Total duties amount", "type": "string", "x-struct": null, "x-validate": null }, "fees": { "description": "Total fees amount", "type": "string", "x-struct": null, "x-validate": null }, "taxes": { "description": "Total taxes amount", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "id": { "description": "Unique identifier for the import cost estimate", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "objects": { "description": "List of objects/items being imported", "items": { "properties": { "country_of_origin": { "description": "ISO 3166-1 alpha-2 country code where the object originated", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "hs_code": { "description": "Harmonized System (HS) tariff code for the object", "type": "string", "x-struct": null, "x-validate": null }, "quantity": { "description": "Quantity of the object", "nullable": true, "type": "number", "x-struct": null, "x-validate": null }, "reference": { "description": "Reference identifier for the object", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "value": { "description": "Declared value of the object", "type": "string", "x-struct": null, "x-validate": null }, "value_currency": { "description": "Currency code (ISO 4217) used for the object's declared value", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "origin": { "description": "Details about the origin location", "properties": { "country": { "description": "ISO 3166-1 alpha-2 country code of the origin", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "quote_id": { "description": "The ID of the quote used to create this import cost estimate, if it was created from a quote", "format": "int64", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "reference": { "description": "Reference string for identifying the estimate in your systems", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "shortcode": { "description": "Short automatically generated reference code for the identifying import cost estimate in Arta's system", "type": "string", "x-struct": null, "x-validate": null }, "status": { "description": "Status of the import cost estimate calculation", "enum": [ "failed", "success" ], "type": "string", "x-struct": null, "x-validate": null }, "transport": { "description": "Information about the transport method and cost", "properties": { "amount": { "description": "Total transport cost", "type": "string", "x-struct": null, "x-validate": null }, "amount_currency": { "description": "Currency code (ISO 4217) for the transport amount", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "service_level": { "description": "Service level for transport (e.g., ups_expedited, fedex_international_first etc). Options are listed in the reference rate service levels metadata endpoint", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "ImportCostEstimate", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.ImportCostEstimate", "x-validate": null }, "MetadataPacking": { "items": { "properties": { "description": { "description": "A long form description", "example": "Object is packed in plastic or bubble only", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The ID representing the resource", "example": "soft_wrap", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "A brief title for the resource", "example": "Soft Wrap", "type": "string", "x-struct": null, "x-validate": null }, "subtypes": { "description": "The subtypes for this resource", "items": { "description": "An object subtype", "properties": { "description": { "description": "A long form description", "example": "Wraped in dartek film.", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The ID representing the resource", "example": "dartek_only", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "A brief title for the resource", "example": "Dartek only", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "title": "MetadataPacking", "type": "array", "x-struct": "Elixir.DocsWeb.Schemas.Response.Metadata.Packing", "x-validate": null }, "EmailSubscriptionUpdate": { "additionalProperties": false, "properties": { "email_subscription": { "properties": { "recipients": { "description": "The list of recipients for this Email Subscription.", "example": [ "destination", "origin" ], "items": { "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "recipients" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "email_subscription" ], "title": "EmailSubscriptionUpdate", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.EmailSubscriptionUpdate", "x-validate": null }, "Upload": { "properties": { "created_at": { "example": "2021-10-27T16:48:38.657228", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "document_type": { "description": "The document type of the uploaded file", "enum": [ "bill_of_lading", "certificate_of_insurance", "certificate_of_insurance_template", "condition_report", "condition_check", "image", "instructions", "airway_bill", "commercial_invoice", "power_of_attorney", "proof_of_export", "proof_of_delivery", "quote", "shipping_label", "other" ], "example": "other", "type": "string", "x-struct": null, "x-validate": null }, "document_type_label": { "description": "A brief label providing additional context about the `document_type`. Required when \"other\" is the `document_type`", "example": "Inventory List", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "download_url": { "example": "https://api.arta.io/downloads/kikhAFZ565BzbGooRqLZl", "nullable": true, "readOnly": true, "type": "string", "x-struct": null, "x-validate": null }, "file_name": { "description": "The name of the uploaded file", "example": "inventory_list_27148_16.pdf", "type": "string", "x-struct": null, "x-validate": null }, "id": { "example": 1942, "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "mime_type": { "description": "The mime-type of the uploaded file", "enum": [ "application/pdf", "application/vnd.ms-excel", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "image/jpeg", "image/png", "text/csv", "video/mp4", "video/quicktime", "application/msword" ], "example": "application/pdf", "type": "string", "x-struct": null, "x-validate": null }, "size": { "description": "The size of the uploaded file in bytes", "example": 58550, "type": "integer", "x-struct": null, "x-validate": null }, "status": { "enum": [ "pending", "processed", "failed" ], "example": "processed", "readOnly": true, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "document_type", "file_name", "mime_type", "size" ], "title": "Upload", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.Upload", "x-validate": null }, "ShipmentCreate": { "oneOf": [ { "additionalProperties": false, "description": "Create a standard Arta shipment", "properties": { "shipment": { "properties": { "customs_process": { "default": "ddu", "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" ], "example": "ddu", "type": "string", "x-struct": null, "x-validate": null }, "exceptions": { "description": "An optional list of exceptions to apply at booking time. Only supported for self-ship shipments. Pass an item with `type: \"label_hold\"` to defer automatic label purchase until the exception is resolved.", "items": { "properties": { "type": { "description": "The exception type to create at booking. Currently the only accepted value is `label_hold`.", "enum": [ "label_hold" ], "example": "label_hold", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "type" ], "type": "object", "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", "example": "Purchase Order: 2801", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "public_reference": { "description": "A client defined name for the request. The value provided for the public_reference field may appear in notification emails and shipment detail pages", "example": "Order #1437", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "quote_id": { "description": "The numeric id of the quote to be booked", "example": "12345", "format": "int64", "type": "integer", "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", "example": "New customer", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "tags": { "description": "A list of tags to associate with this shipment. Tags present on the request will also be set on the shipment", "items": { "description": "The name of an active tag belonging to your organization.", "example": "vip", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "quote_id" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "shipment" ], "title": "ArtaShipmentPayload", "type": "object", "x-struct": null, "x-validate": null }, { "additionalProperties": false, "description": "Create a track shipment", "properties": { "shipment": { "properties": { "destination": { "description": "The destination location for the shipment. If provided, the data in this object will overwrite the destination address data for this shipment that is stored on Arta's system, not the one on the commercial carrier's system", "nullable": true, "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", "example": "87 Richardson St", "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "Second line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "address_line_3": { "description": "Third line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "City", "example": "Brooklyn", "type": "string", "x-struct": null, "x-validate": null }, "contacts": { "description": "A list of contacts at the location", "items": { "properties": { "email_address": { "example": "docs@arta.io", "type": "string", "x-struct": null, "x-validate": null }, "name": { "example": "Contact Name", "type": "string", "x-struct": null, "x-validate": null }, "phone_number": { "example": "646 828 7333", "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", "example": "US", "maxLength": 2, "minLength": 2, "required": true, "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "The postal code", "example": "11211", "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations", "example": "NY", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The title or name of the location", "example": "Gallery", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "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", "example": "Purchase Order: 2801", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "origin": { "description": "The originating location for the shipment. If provided, the data in this object will overwrite the origin address data for this shipment that is stored on Arta's system, not the one on the commercial carrier's system", "nullable": true, "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", "example": "87 Richardson St", "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "Second line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "address_line_3": { "description": "Third line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "City", "example": "Brooklyn", "type": "string", "x-struct": null, "x-validate": null }, "contacts": { "description": "A list of contacts at the location", "items": { "properties": { "email_address": { "example": "docs@arta.io", "type": "string", "x-struct": null, "x-validate": null }, "name": { "example": "Contact Name", "type": "string", "x-struct": null, "x-validate": null }, "phone_number": { "example": "646 828 7333", "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", "example": "US", "maxLength": 2, "minLength": 2, "required": true, "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "The postal code", "example": "11211", "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations", "example": "NY", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The title or name of the location", "example": "Gallery", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "packages": { "description": "The shipments packages are formatted as a list, however, Track shipments only support a single package. You can provide details about the package being shipped, including the object details within the package", "items": { "properties": { "depth": { "description": "The depth of the object", "example": "3", "type": "string", "x-struct": null, "x-validate": null }, "height": { "description": "The height of the object", "example": "32", "type": "string", "x-struct": null, "x-validate": null }, "objects": { "description": "A list of objects in the package", "items": { "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", "example": "US", "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", "example": "123456", "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", "example": "oil on canvas", "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", "example": true, "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", "example": "1980", "type": "string", "x-struct": null, "x-validate": null }, "creator": { "description": "The creator of the object", "example": "Bob Smithson", "type": "string", "x-struct": null, "x-validate": null }, "notes": { "description": "Any notes about the item", "example": "Artist signature in the lower left corner", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The object title", "example": "Black Rectangle", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "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", "example": "Accession ID: 823", "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", "example": "Round Smithson work", "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", "example": "painting_framed", "pattern": "^[0-9a-z_]{1,56}$", "type": "string", "x-struct": null, "x-validate": null }, "value": { "$ref": "#/components/schemas/MonetaryAmount" }, "value_currency": { "$ref": "#/components/schemas/Currency" } }, "required": [ "type", "value" ], "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": { "example": "no_packing", "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", "example": "US", "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", "example": "123456", "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", "example": "oil on canvas", "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", "example": true, "type": "boolean", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "depth": { "description": "The depth of the object", "example": "3", "type": "string", "x-struct": null, "x-validate": null }, "details": { "properties": { "creation_date": { "description": "Details about the timing in which an object was created", "example": "1980", "type": "string", "x-struct": null, "x-validate": null }, "creator": { "description": "The creator of the object", "example": "Bob Smithson", "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": { "example": "canvas", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "notes": { "description": "Any notes about the item", "example": "Artist signature in the lower left corner", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The object title", "example": "Black Rectangle", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "height": { "description": "The height of the object", "example": "32", "type": "string", "x-struct": null, "x-validate": null }, "images": { "description": "A list image urls of the object", "items": { "example": "http://example.com/image.jpg", "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", "example": "Accession ID: 823", "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", "example": "Round Smithson work", "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", "example": "painting_unframed", "pattern": "^[0-9a-z_]{1,56}$", "type": "string", "x-struct": null, "x-validate": null }, "unit_of_measurement": { "enum": [ "in", "cm" ], "example": "in", "type": "string", "x-struct": null, "x-validate": null }, "value": { "$ref": "#/components/schemas/MonetaryAmount" }, "value_currency": { "$ref": "#/components/schemas/Currency" }, "weight": { "description": "The weight of the object", "example": "3.0", "type": "string", "x-struct": null, "x-validate": null }, "weight_unit": { "description": "The unit of the object", "enum": [ "lb", "kg" ], "example": "lb", "type": "string", "x-struct": null, "x-validate": null }, "width": { "description": "The width of the object", "example": "15", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "packing_materials": { "description": "The id of a material.", "items": { "example": "cardboard", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "unit_of_measurement": { "enum": [ "in", "cm" ], "example": "in", "type": "string", "x-struct": null, "x-validate": null }, "weight": { "description": "The weight of the object", "example": "3.0", "type": "string", "x-struct": null, "x-validate": null }, "weight_unit": { "description": "The unit of the object", "enum": [ "lb", "kg" ], "example": "lb", "type": "string", "x-struct": null, "x-validate": null }, "width": { "description": "The width of the object", "example": "15", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "public_reference": { "description": "A client defined name for the request. The value provided for the public_reference field may appear in notification emails and shipment detail pages", "example": "Order #1437", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "shipping_notes": { "description": "This field can be used to provide Arta any additional context about the shipment", "example": "New customer", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "tags": { "description": "A list of tags to associate with this shipment", "items": { "description": "The name of an active tag belonging to your organization.", "example": "vip", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "tracking": { "description": "The tracking details for a shipment purchased off of the Arta platform. This information should come from a commercial carrier such as DHL, FedEx, or UPS. Exactly one item is required", "items": { "properties": { "carrier": { "description": "The id of a supported commercial carrier. These can be obtained via the GET /metadata/commercial_carriers endpoint", "example": "ups", "type": "string", "x-struct": null, "x-validate": null }, "tracking_number": { "description": "The tracking number of the shipment provided by the commercial carrier", "example": "1ZXXXXXXXXXXXXXXXX", "type": "string", "x-struct": null, "x-validate": null }, "url": { "description": "The url that links to the tracking page on the commercial carrier's website", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "carrier", "tracking_number" ], "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null } }, "required": [ "tracking" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "shipment" ], "title": "TrackShipmentPayload", "type": "object", "x-struct": null, "x-validate": null } ], "title": "ShipmentCreate", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.ShipmentCreate", "x-validate": null }, "ShareRequest": { "additionalProperties": false, "description": "Create hosted booking session from an existing quote request", "properties": { "hosted_session": { "properties": { "request_id": { "description": "The ID of an existing Request to be shared.", "required": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "hosted_session" ], "title": "ShareRequest", "type": "object", "x-struct": null, "x-validate": null }, "MinimalLocation": { "description": "A minimal representation of the destination address for the shipment", "properties": { "city": { "description": "The destination address city", "example": "Los Angeles", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "country": { "description": "The destination address country in 2-digit ISO 3166-1 alpha-2 format", "example": "US", "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "The destination address postal code", "example": "90024", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "The destination address region", "example": "CA", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "title": "MinimalLocation", "type": "object", "x-struct": null, "x-validate": null }, "Shipment": { "example": { "created_at": "2021-01-21T21:00:58.403150", "customs_end_use": "not_for_resale", "customs_process": "ddu", "destination": { "access_restrictions": [], "address_line_1": "87 Richardson St", "address_line_2": null, "address_line_3": null, "city": "New York", "contacts": [ { "email_address": "al@example.com", "name": "Alfred Barr", "phone_number": "(222) 222-2222" } ], "country": "US", "postal_code": "11249", "region": "NY", "title": "Home" }, "eei_form_status": null, "eei_form_url": null, "emissions": "0.03", "emissions_unit": "kg_co2e", "exceptions": [], "id": "6b12c76a-5217-4cd6-82d8-7aa5265ebaad", "insurance_policy": null, "internal_reference": null, "object_count": 1, "origin": { "access_restrictions": [], "address_line_1": "11 W 53rd St", "address_line_2": null, "address_line_3": null, "city": "New York", "contacts": [ { "email_address": "mary@example.com", "name": "Mary Quinn Sullivan", "phone_number": "(333) 333-3333" } ], "country": "US", "postal_code": "10019", "region": "NY", "title": "Warehouse" }, "package_count": 1, "packages": [ { "depth": "6.0", "eta": "05/09/2022", "handle_with_care": false, "height": "14.5", "id": 131, "is_sufficiently_packed": false, "objects": [ { "components": [ { "customs": { "country_of_origin": "US", "hs_code": "123456", "medium": "oil on canvas", "temporary_admission": true }, "details": { "creation_date": "1980", "creator": "Bob Smithson", "notes": "Artist signature in the lower left corner", "title": "Black Rectangle" }, "id": "1f26b6e1-ce25-43a9-b4ea-2ceaac24ec3a", "internal_reference": "Accession ID: 823", "public_reference": "Round Smithson work", "type": "painting_framed", "value": "15000", "value_currency": "USD" } ], "current_packing": [ "cardboard_box" ], "depth": "2", "details": { "creation_date": null, "creator": null, "is_cites": false, "is_fragile": false, "materials": [], "notes": null, "title": null }, "height": "10.5", "id": 621, "images": [], "internal_reference": null, "public_reference": null, "subtype": "prepacked_box", "type": "client_package", "unit_of_measurement": "in", "value": "15000", "value_currency": "USD", "weight": "3.5", "weight_unit": "lb", "width": "10" }, { "components": [], "current_packing": [], "customs": { "country_of_origin": "US", "hs_code": "123456", "medium": "oil on canvas", "temporary_admission": true }, "depth": "2", "details": { "creation_date": null, "creator": "Robert Irwin", "is_cites": false, "is_fragile": false, "materials": [], "notes": "Artist signature in the lower left corner", "title": "All That Jazz" }, "height": "10.5", "id": 620, "images": [], "internal_reference": null, "public_reference": null, "subtype": "painting_unframed", "type": "art", "unit_of_measurement": "in", "value": "1500", "value_currency": "USD", "weight": "3.5", "weight_unit": "lb", "width": "10" } ], "packing_materials": [ "strongbox" ], "status": "pending", "weight": "3.5", "weight_unit": "lb", "width": "14.0" } ], "payment_process": "invoicing", "public_reference": null, "quote_type": "parcel", "schedule": { "delivery_end": null, "delivery_start": null, "delivery_window_modifier": "", "pickup_end": null, "pickup_start": null, "pickup_window_modifier": "" }, "services": [ { "amount": "1", "amount_currency": "USD", "included_services": [], "is_requested": false, "is_required": true, "metadata": { "reference_rate": { "provider": "fedex", "service_level": "fedex_standard_overnight" } }, "name": "UPS Next Day Air", "sub_subtype": "parcel", "subtype": "parcel", "type": "transport" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "is_requested": false, "is_required": true, "metadata": {}, "name": "Strongbox", "sub_subtype": "strongbox", "subtype": "packing_materials", "type": "packing" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "is_requested": false, "is_required": true, "metadata": {}, "name": "Collection", "sub_subtype": "collection", "subtype": "collection", "type": "location" }, { "amount": "1", "amount_currency": "USD", "included_services": [], "is_requested": false, "is_required": true, "metadata": {}, "name": "Fuel Surcharge", "sub_subtype": "fuel_surcharge", "subtype": "fees", "type": "taxes_duties_fees" } ], "shipping_notes": null, "shortcode": "MA-452144", "status": "pending", "tags": [], "total": "4", "total_currency": "USD", "tracking": [], "updated_at": "2021-01-21T21:00:58.579870", "url": "https://connect.shiparta.com/shipments/6b12c76a-5217-4cd6-82d8-7aa5265egood/5xTRnCvYkdMFdcFFMWUZaCmXz" }, "properties": { "created_at": { "description": "A NaiveDatetime-formatted timestamp describing when the resource was created with microsecond precision", "example": "2024-08-13T22:44:39.593704", "format": "date-time", "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" ], "example": "not_for_resale", "nullable": true, "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" ], "example": "ddu", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "destination": { "$ref": "#/components/schemas/Location" }, "eei_form_status": { "description": "The status of an associated electronic export information document required for customs clearance. Returns null if the shipment does not have an associated EEI Form", "enum": [ "approved", "cleared", "pending", "rejected", "submitted" ], "example": "pending", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "eei_form_url": { "description": "The URL for an associated electronic export information form required for customs clearance. Returns null if the shipment does not have an associated EEI Form", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "emissions": { "description": "The estimated CO2 emissions for the shipment", "example": "0.5", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "emissions_unit": { "description": "The unit of measurement for emissions for this shipment. Typically measured in \"kg_co2e\" or \"kilograms of carbon dioxide equivalent\"", "example": "kg_co2e", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "exceptions": { "description": "Shipment exceptions provide context about holds, delays, and other circumstances that may interrupt a shipment's fulfillment", "items": { "properties": { "created_at": { "description": "A NaiveDatetime-formatted timestamp describing when the exception was created with microsecond precision", "example": "2024-08-13T22:44:39.593704", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "exception_type_label": { "description": "An additional label providing context about the exception type (optional)", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "hold_until": { "description": "The date the shipment will be held until", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The id of the exception in UUID format", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "package_id": { "description": "The package associated with this exception (optional)", "example": "12345", "format": "int64", "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "resolution": { "description": "A brief description of the method by which this exception was resolved", "example": "Balance Cleared", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "source": { "description": "The source of the exception", "example": "arta_team", "type": "string", "x-struct": null, "x-validate": null }, "status": { "description": "The current status for this exception", "enum": [ "new", "in_progress", "resolved" ], "example": "resolved", "type": "string", "x-struct": null, "x-validate": null }, "type": { "description": "The type of exception", "example": "prepayment_required", "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "description": "A NaiveDatetime-formatted timestamp describing when the exception was last updated with microsecond precision", "example": "2024-08-13T22:44:39.593704", "format": "date-time", "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", "example": 4215, "nullable": true, "type": "integer", "x-struct": null, "x-validate": null }, "id": { "description": "The id of the shipment in UUID format", "format": "uuid", "type": "string", "x-struct": null, "x-validate": null }, "insurance_policy": { "nullable": true, "properties": { "amount": { "$ref": "#/components/schemas/MonetaryAmount" }, "amount_currency": { "$ref": "#/components/schemas/Currency" }, "id": { "example": "arta_transit_insurance", "type": "string", "x-struct": null, "x-validate": null }, "insured_value": { "$ref": "#/components/schemas/MonetaryAmount" }, "insured_value_currency": { "$ref": "#/components/schemas/Currency" } }, "type": "object", "x-struct": null, "x-validate": null }, "internal_reference": { "description": "This field can be used to pass through any character data that you may want returned unaltered for your own later usage", "maxLength": 255, "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "log_request_id": { "description": "A string identifying the API request that created the shipment. This `log_request_id` may be used to find the Log associated with the source API request", "example": "F-uX-m3bUWEb2vwAECSB", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "object_count": { "description": "The count of objects included in the shipment", "example": 1, "format": "int64", "type": "integer", "x-struct": null, "x-validate": null }, "origin": { "$ref": "#/components/schemas/Location" }, "package_count": { "description": "The count of packages included in the shipment", "example": 1, "format": "int64", "type": "integer", "x-struct": null, "x-validate": null }, "packages": { "items": { "$ref": "#/components/schemas/Package" }, "type": "array", "x-struct": null, "x-validate": null }, "payment_process": { "description": "The primary method by which payment to Arta will be handled for any shipment booked through this hosted session", "enum": [ "checkout", "invoicing" ], "example": "checkout", "type": "string", "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, "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "quote_type": { "description": "The ID of the quote type associated with this shipment", "enum": [ "premium", "select", "parcel", "self_ship" ], "example": "premium", "type": "string", "x-struct": null, "x-validate": null }, "schedule": { "description": "The schedule for the shipment", "properties": { "delivery_end": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "delivery_start": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "delivery_window_modifier": { "description": "A qualifying word indicating how delivery_start and delivery_end together shape the delivery window. When present, values may be \"after\", \"by\", \"on\", or \"between\"", "example": "on", "type": "string", "x-struct": null, "x-validate": null }, "pickup_end": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "pickup_start": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "pickup_window_modifier": { "description": "A qualifying word indicating how delivery_start and delivery_end together shape the delivery window. When present, values may be \"after\", \"by\", \"on\", or \"between\"", "example": "on", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "services": { "description": "A list of services included in the shipment", "items": { "$ref": "#/components/schemas/Service" }, "type": "array", "x-struct": null, "x-validate": null }, "shipping_notes": { "description": "Any additional unstructured notes to Arta about the shipment", "maxLength": 255, "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "shortcode": { "description": "A brief identifier for this shipment", "example": "DEMO-B8FIRV", "type": "string", "x-struct": null, "x-validate": null }, "status": { "description": "The status for this shipment", "enum": [ "pending", "confirmed", "collected", "in_transit", "completed", "cancelled" ], "example": "pending", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "tags": { "description": "A list of tags associated with the shipment", "items": { "$ref": "#/components/schemas/Tag" }, "type": "array", "x-struct": null, "x-validate": null }, "total": { "$ref": "#/components/schemas/MonetaryAmount" }, "total_currency": { "$ref": "#/components/schemas/Currency" }, "tracking": { "description": "A list of tracking details for the packages in a shipment", "items": { "properties": { "carrier_name": { "description": "The name of the carrier providing transport services for a specific package", "example": "UPS", "type": "string", "x-struct": null, "x-validate": null }, "label_format_urls": { "description": "A map of shipping label format types to their respective download URLs. Returns null if no shipping label exists", "example": { "pdf_4_x_6": "https://labels.example.com/labels/456/token123?format=pdf_4_x_6", "pdf_a4": "https://labels.example.com/labels/456/token123?format=pdf_a4", "pdf_a4_half_page": "https://labels.example.com/labels/456/token123?format=pdf_a4_half_page", "pdf_letter": "https://labels.example.com/labels/456/token123?format=pdf_letter", "pdf_letter_half_page": "https://labels.example.com/labels/456/token123?format=pdf_letter_half_page", "png_4_x_6": "https://labels.example.com/labels/456/token123?format=png_4_x_6", "zpl_12dpmm": "https://labels.example.com/labels/456/token123?format=zpl_12dpmm", "zpl_8dpmm": "https://labels.example.com/labels/456/token123?format=zpl_8dpmm" }, "nullable": true, "properties": { "pdf_4_x_6": { "description": "PDF 4x6 inch label - centered and scaled to full size with 0.5 inch margins on all sides", "example": "https://labels.example.com/labels/456/token123?format=pdf_4_x_6", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "pdf_a4": { "description": "PDF A4 (8.3x11.7 inch) - centered and scaled to full size with 1 inch top/bottom and 1.25 inch left/right margins", "example": "https://labels.example.com/labels/456/token123?format=pdf_a4", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "pdf_a4_half_page": { "description": "PDF A4 landscape (11.7x8.3 inch) - 4x6 label on left half with 1.15 inch top/bottom and 1.85 inch left/right margins", "example": "https://labels.example.com/labels/456/token123?format=pdf_a4_half_page", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "pdf_letter": { "description": "PDF US Letter (8.5x11 inch) - centered and scaled to full size with 1 inch margins on all sides", "example": "https://labels.example.com/labels/456/token123?format=pdf_letter", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "pdf_letter_half_page": { "description": "PDF US Letter landscape (11x8.5 inch) - 4x6 label on left half with 1.5 inch top/bottom and 1.25 inch left/right margins", "example": "https://labels.example.com/labels/456/token123?format=pdf_letter_half_page", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "png_4_x_6": { "description": "PNG 4x6 inch label - centered on the page and scaled to fill exactly 4x6 inches (no margins)", "example": "https://labels.example.com/labels/456/token123?format=png_4_x_6", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "zpl_12dpmm": { "description": "ZPL for 12 dots/mm (300 DPI) printers - 4x6 label centered on the media at native resolution", "example": "https://labels.example.com/labels/456/token123?format=zpl_12dpmm", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "zpl_8dpmm": { "description": "ZPL for 8 dots/mm (203 DPI) printers - 4x6 label centered on the media at native resolution", "example": "https://labels.example.com/labels/456/token123?format=zpl_8dpmm", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "label_url": { "description": "A URL at which parcel package shipping labels may be downloaded and printed", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "package_id": { "description": "The ID associated with the tracking detail's corresponding package", "example": "12345", "format": "int64", "type": "integer", "x-struct": null, "x-validate": null }, "tracking_number": { "description": "The carrier-providing tracking number for this package", "example": "1ZXXXXXXXXXXXXXXXX", "type": "string", "x-struct": null, "x-validate": null }, "url": { "description": "A carrier-provided URL for fetching delivery events related to this package's transport", "example": "https://www.ups.com/track?loc=en_us&tracknum=1ZXXXXXXXXXXXXXXXX&Requester=NS/", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "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", "example": "2024-08-13T22:44:39.593704", "format": "date-time", "type": "string", "x-struct": null, "x-validate": null }, "url": { "description": "The track URL for this shipment on the Arta web platform", "example": "https://connect.shiparta.com/shipments/6b12c76a-5217-4cd6-82d8-7aa5265egood/5xTRnCvYkdMFdcFFMWUZaCmXz", "type": "string", "x-struct": null, "x-validate": null } }, "title": "Shipment", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.Shipment", "x-validate": null }, "MetadataQuote": { "items": { "properties": { "description": { "description": "A long form description", "example": "Specialized climate-controlled transportation operated by trained technicians from wall-to-wall", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The ID representing the resource", "example": "premium", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "A brief title for the resource", "example": "Arta Premium", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "title": "MetadataQuote", "type": "array", "x-struct": "Elixir.DocsWeb.Schemas.Response.Metadata.Quote", "x-validate": null }, "Log": { "example": { "api_key_id": 1, "arta_version": "2020-10-22", "created_at": "2020-10-23T20:34:29.066599", "end_at": "2020-10-23T20:34:28.816433", "id": 320, "method": "POST", "path": "/requests", "query_params": "{}", "request_body": "", "request_id": "FkC5WHWtbZuuUtcAArFx", "response_body": "", "start_at": "2020-10-23T20:34:16.928374", "status": 200, "updated_at": "2020-10-23T20:34:29.066599" }, "properties": { "api_key_id": { "format": "int64", "type": "integer", "x-struct": null, "x-validate": null }, "arta_version": { "type": "string", "x-struct": null, "x-validate": null }, "created_at": { "type": "string", "x-struct": null, "x-validate": null }, "end_at": { "type": "string", "x-struct": null, "x-validate": null }, "id": { "format": "int64", "type": "integer", "x-struct": null, "x-validate": null }, "method": { "type": "string", "x-struct": null, "x-validate": null }, "path": { "type": "string", "x-struct": null, "x-validate": null }, "query_params": { "type": "string", "x-struct": null, "x-validate": null }, "request_body": { "type": "string", "x-struct": null, "x-validate": null }, "request_id": { "type": "string", "x-struct": null, "x-validate": null }, "response_body": { "type": "string", "x-struct": null, "x-validate": null }, "start_at": { "type": "string", "x-struct": null, "x-validate": null }, "status": { "format": "int64", "type": "integer", "x-struct": null, "x-validate": null }, "updated_at": { "type": "string", "x-struct": null, "x-validate": null } }, "title": "Log", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.Log", "x-validate": null }, "Package": { "properties": { "depth": { "description": "The depth of the object", "example": "3", "type": "string", "x-struct": null, "x-validate": null }, "eta": { "description": "The expected delivery date for this package in the `MM/DD/YYYY` format", "example": "01/01/2021", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "handle_with_care": { "description": "Set this flag to true if the package should be handled with care", "type": "boolean", "x-struct": null, "x-validate": null }, "height": { "description": "The height of the object", "example": "32", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The id of the package", "format": "int64", "type": "integer", "x-struct": null, "x-validate": null }, "is_sufficiently_packed": { "description": "Set this flag to true if the package is sufficiently packed", "type": "boolean", "x-struct": null, "x-validate": null }, "objects": { "description": "A list of objects in the package", "items": { "$ref": "#/components/schemas/Object" }, "type": "array", "x-struct": null, "x-validate": null }, "packing_materials": { "description": "The id of a material.", "items": { "example": "cardboard", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "status": { "description": "The status of the package", "example": "pending", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "unit_of_measurement": { "enum": [ "in", "cm" ], "example": "in", "type": "string", "x-struct": null, "x-validate": null }, "weight": { "description": "The weight of the object", "example": "3.0", "type": "string", "x-struct": null, "x-validate": null }, "weight_unit": { "description": "The unit of the object", "enum": [ "lb", "kg" ], "example": "lb", "type": "string", "x-struct": null, "x-validate": null }, "width": { "description": "The width of the object", "example": "15", "type": "string", "x-struct": null, "x-validate": null } }, "title": "Package", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.Package", "x-validate": null }, "InboundBookingSession": { "additionalProperties": false, "description": "Create hosted inbound booking session", "properties": { "hosted_session": { "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, meaning this may disqualify certain segments of shipping services we offer.", "items": { "description": "The id of a service.", "example": "signature_delivery", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "can_user_confirm_object_dimensions": { "default": false, "description": "Determines whether your customer can verify and update object dimension information when completing an inbound booking session.", "type": "boolean", "x-struct": null, "x-validate": null }, "cancel_url": { "description": "The URL the user will be redirected to after a Arta Booking session is cancelled", "example": "http://example.com/cancelled", "type": "string", "x-struct": null, "x-validate": null }, "customs_end_use": { "default": "not_for_resale", "description": "The intended end use of the items being shipped for customs purposes", "enum": [ "for_resale", "not_for_resale" ], "example": "not_for_resale", "type": "string", "x-struct": null, "x-validate": null }, "customs_process": { "default": "ddu", "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" ], "example": "ddu", "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", "example": "87 Richardson St", "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "Second line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "address_line_3": { "description": "Third line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "City", "example": "Brooklyn", "type": "string", "x-struct": null, "x-validate": null }, "contacts": { "description": "A list of contacts at the location", "items": { "properties": { "email_address": { "example": "docs@arta.io", "type": "string", "x-struct": null, "x-validate": null }, "name": { "example": "Contact Name", "type": "string", "x-struct": null, "x-validate": null }, "phone_number": { "example": "646 828 7333", "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", "example": "US", "maxLength": 2, "minLength": 2, "required": true, "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "The postal code", "example": "11211", "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations", "example": "NY", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The title or name of the location", "example": "Gallery", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "insurance": { "description": "The ID of the requested Arta insurance type. Options are defined in the Insurances metadata endpoint", "example": "arta_transit_insurance", "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", "example": "Purchase Order: 2801", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "objects": { "items": { "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", "example": "US", "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", "example": "123456", "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", "example": "oil on canvas", "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", "example": true, "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", "example": "1980", "type": "string", "x-struct": null, "x-validate": null }, "creator": { "description": "The creator of the object", "example": "Bob Smithson", "type": "string", "x-struct": null, "x-validate": null }, "notes": { "description": "Any notes about the item", "example": "Artist signature in the lower left corner", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The object title", "example": "Black Rectangle", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "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", "example": "Accession ID: 823", "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", "example": "Round Smithson work", "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", "example": "painting_framed", "pattern": "^[0-9a-z_]{1,56}$", "type": "string", "x-struct": null, "x-validate": null }, "value": { "$ref": "#/components/schemas/MonetaryAmount" }, "value_currency": { "$ref": "#/components/schemas/Currency" } }, "required": [ "type", "value" ], "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": { "example": "no_packing", "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", "example": "US", "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", "example": "123456", "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", "example": "oil on canvas", "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", "example": true, "type": "boolean", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "depth": { "description": "The depth of the object", "example": "3", "type": "string", "x-struct": null, "x-validate": null }, "details": { "properties": { "creation_date": { "description": "Details about the timing in which an object was created", "example": "1980", "type": "string", "x-struct": null, "x-validate": null }, "creator": { "description": "The creator of the object", "example": "Bob Smithson", "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": { "example": "canvas", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "notes": { "description": "Any notes about the item", "example": "Artist signature in the lower left corner", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The object title", "example": "Black Rectangle", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "height": { "description": "The height of the object", "example": "32", "type": "string", "x-struct": null, "x-validate": null }, "images": { "description": "A list image urls of the object", "items": { "example": "http://example.com/image.jpg", "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", "example": "Accession ID: 823", "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", "example": "Round Smithson work", "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", "example": "painting_unframed", "pattern": "^[0-9a-z_]{1,56}$", "type": "string", "x-struct": null, "x-validate": null }, "unit_of_measurement": { "enum": [ "in", "cm" ], "example": "in", "type": "string", "x-struct": null, "x-validate": null }, "value": { "$ref": "#/components/schemas/MonetaryAmount" }, "value_currency": { "$ref": "#/components/schemas/Currency" }, "weight": { "description": "The weight of the object", "example": "3.0", "type": "string", "x-struct": null, "x-validate": null }, "weight_unit": { "description": "The unit of the object", "enum": [ "lb", "kg" ], "example": "lb", "type": "string", "x-struct": null, "x-validate": null }, "width": { "description": "The width of the object", "example": "15", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "subtype", "value" ], "type": "object", "x-struct": null, "x-validate": null }, "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", "example": "87 Richardson St", "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "Second line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "address_line_3": { "description": "Third line of address", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "City", "example": "Brooklyn", "type": "string", "x-struct": null, "x-validate": null }, "contacts": { "description": "A list of contacts at the location", "items": { "properties": { "email_address": { "example": "docs@arta.io", "type": "string", "x-struct": null, "x-validate": null }, "name": { "example": "Contact Name", "type": "string", "x-struct": null, "x-validate": null }, "phone_number": { "example": "646 828 7333", "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", "example": "US", "maxLength": 2, "minLength": 2, "required": true, "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "The postal code", "example": "11211", "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "Political region name, for US states and Canada provinces, use 2 letter abbreviations", "example": "NY", "type": "string", "x-struct": null, "x-validate": null }, "title": { "description": "The title or name of the location", "example": "Gallery", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "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.", "example": [ "ground" ], "items": { "type": "string", "x-struct": null, "x-validate": null }, "nullable": true, "type": "array", "x-struct": null, "x-validate": null }, "preferred_quote_types": { "description": "Optionally instruct the Arta API to return a subset of quote types for the requests generated through this hosted session. For example if you would prefer to only return Select quotes, you can set this field to `[\"select\"]` The list valid quote type IDs are available at the /metadata/quotes endpoint.", "example": [ "parcel" ], "items": { "type": "string", "x-struct": null, "x-validate": null }, "nullable": true, "type": "array", "x-struct": null, "x-validate": null }, "public_instructions_booking_review": { "description": "A client defined multi-line block of text presented to users in the quote review modal window prior to booking a shipment for booking, shared request, and inbound booking sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "type": "string", "x-struct": null, "x-validate": null }, "public_instructions_confirmation": { "description": "A client defined multi-line block of text presented to users on the post-shipment booking confirmation view for booking, shared request, and inbound booking hosted sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "type": "string", "x-struct": null, "x-validate": null }, "public_instructions_location_quotes": { "description": "A client defined multi-line block of text presented to users on the location and quote selection view for booking, shared request, and inbound booking hosted sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "type": "string", "x-struct": null, "x-validate": null }, "public_instructions_object_details": { "description": "A client defined multi-line block of text presented to users on the object form in inbound booking hosted sessions.\n\n- Only visible if `can_user_confirm_object_dimensions` is true\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "example": "Please confirm the dimensions of the objects you are shipping.", "type": "string", "x-struct": null, "x-validate": null }, "public_instructions_payment": { "description": "A client defined multi-line block of text presented to users on the post-shipment booking payment view when required for booking, shared request, and inbound booking hosted sessions.\n\n- Supports multiple lines and markdown-inspired anchor link syntax `[view more](https://moma.org/)`\n\n- Rendered text supports a maximum of 400 characters not including links and markup", "type": "string", "x-struct": null, "x-validate": null }, "public_reference": { "description": "A client defined name for the request. The value provided for the public_reference field may appear in notification emails and shipment detail pages", "example": "Order #1437", "maxLength": 255, "type": "string", "x-struct": null, "x-validate": null }, "quoting_strategy": { "default": "best_rate", "description": "The quoting strategy used when creating quote requests for this booking session. Determines whether the API returns a single best-rate option per transport speed or multiple carrier options for comparison", "enum": [ "best_rate", "compare_carriers" ], "example": "best_rate", "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", "example": "New customer", "type": "string", "x-struct": null, "x-validate": null }, "success_url": { "description": "The URL the user will be redirected to after a Arta Booking session is completed", "example": "http://example.com/success", "type": "string", "x-struct": null, "x-validate": null }, "tags": { "description": "A list of tags to associate with this hosted session", "items": { "description": "The name of an active tag belonging to your organization.", "example": "spring-jewelry-sale", "type": "string", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "type": { "default": "inbound_booking", "description": "The type of the hosted session", "enum": [ "inbound_booking" ], "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "destination", "type" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "hosted_session" ], "title": "InboundBookingSession", "type": "object", "x-struct": null, "x-validate": null }, "MetadataPaymentProcessType": { "items": { "properties": { "description": { "description": "A long form description", "example": "The total is paid to Arta through an Arta Checkout payment.", "type": "string", "x-struct": null, "x-validate": null }, "id": { "description": "The ID representing the resource", "example": "checkout", "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "A brief title for the resource", "example": "Checkout", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null }, "title": "MetadataPaymentProcessType", "type": "array", "x-struct": "Elixir.DocsWeb.Schemas.Response.Metadata.PaymentProcessType", "x-validate": null }, "SelfShipCollectionCreate": { "additionalProperties": false, "properties": { "self_ship_collection": { "properties": { "collection_date": { "description": "Pickup date in ISO 8601 format (`YYYY-MM-DD`). Must be in the future.", "example": "2026-03-06", "format": "date", "type": "string", "x-struct": null, "x-validate": null }, "collection_time": { "description": "Pickup time in ISO 8601 format (`HH:MM:SS`). Must be before `location.close_time`.", "example": "10:00:00", "type": "string", "x-struct": null, "x-validate": null }, "location": { "description": "Pickup location details", "properties": { "address_line_1": { "description": "Street address", "example": "123 Main St", "minLength": 1, "type": "string", "x-struct": null, "x-validate": null }, "address_line_2": { "description": "Additional address info", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "city": { "description": "City", "example": "New York", "minLength": 1, "type": "string", "x-struct": null, "x-validate": null }, "close_time": { "description": "Location closing time in ISO 8601 format (`HH:MM:SS`). Must be after `collection_time`.", "example": "17:00:00", "type": "string", "x-struct": null, "x-validate": null }, "contact": { "description": "Contact at the pickup location", "properties": { "email_address": { "description": "Contact email address", "example": "john@example.com", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "name": { "description": "Contact name", "example": "John Doe", "type": "string", "x-struct": null, "x-validate": null }, "phone_number": { "description": "Contact phone number", "example": "+1-555-123-4567", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "name", "phone_number" ], "type": "object", "x-struct": null, "x-validate": null }, "country": { "description": "Two-letter country code. Currently `US` and `GB` are supported.", "example": "US", "type": "string", "x-struct": null, "x-validate": null }, "package_location": { "description": "Where packages are located at the pickup location", "enum": [ "front", "none", "rear", "side" ], "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "description": "Postal code", "example": "10001", "minLength": 1, "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "State or territory code. Required and validated for `US` (must be a valid US state/territory code). Stripped to empty string for `GB`.", "example": "NY", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "address_line_1", "city", "country", "region", "postal_code", "close_time", "package_location", "contact" ], "type": "object", "x-struct": null, "x-validate": null }, "service": { "description": "Carrier service details", "properties": { "carrier": { "description": "Carrier identifier", "enum": [ "fedex" ], "type": "string", "x-struct": null, "x-validate": null }, "code": { "description": "Service level code", "enum": [ "express", "ground" ], "type": "string", "x-struct": null, "x-validate": null }, "route": { "description": "Route type", "enum": [ "domestic", "international" ], "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "carrier", "code" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "location", "service", "collection_date", "collection_time" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "self_ship_collection" ], "title": "SelfShipCollectionCreate", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.RequestBody.SelfShipCollectionCreate", "x-validate": null }, "InvoicePayment": { "example": { "amount": "502.25", "amount_currency": "USD", "created_at": "2021-02-19T19:09:57.971464", "id": 1, "invoice_id": 11, "payment_id": 1, "shipment_id": "45360593-6c6c-44ab-8a17-0fd198fff058", "updated_at": "2021-02-19T19:09:57.971464" }, "properties": { "amount": { "type": "string", "x-struct": null, "x-validate": null }, "amount_currency": { "type": "string", "x-struct": null, "x-validate": null }, "created_at": { "type": "string", "x-struct": null, "x-validate": null }, "id": { "type": "integer", "x-struct": null, "x-validate": null }, "invoice_id": { "type": "integer", "x-struct": null, "x-validate": null }, "payment_id": { "type": "integer", "x-struct": null, "x-validate": null }, "shipment_id": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "updated_at": { "type": "string", "x-struct": null, "x-validate": null } }, "title": "InvoicePayment", "type": "object", "x-struct": "Elixir.DocsWeb.Schemas.Response.InvoicePayment", "x-validate": null }, "DirectImportCostEstimatePayload": { "additionalProperties": false, "description": "Create an import cost estimate by providing origin, destination, objects, and transport details directly", "example": { "import_cost_estimate": { "currency": "USD", "destination": { "country": "CA", "region": "ON" }, "objects": [ { "hs_code": "691390", "reference": "ceramic-vase-maria-lundqvist", "value": "10869.45" } ], "origin": { "country": "US" }, "transport": { "amount": "20000", "service_level": "ups_expedited" } } }, "properties": { "import_cost_estimate": { "properties": { "currency": { "default": "USD", "description": "ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint", "example": "USD", "maxLength": 3, "minLength": 3, "pattern": "^[A-Z]{3}$", "title": "Currency", "type": "string", "x-struct": null, "x-validate": null }, "destination": { "description": "Details about the destination where it will be imported to", "properties": { "city": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "country": { "description": "ISO 3166-1 alpha-2 country code of the destination", "type": "string", "x-struct": null, "x-validate": null }, "postal_code": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "region": { "description": "State, province, or region of the destination. May be required depending on the destination country.", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "country" ], "type": "object", "x-struct": null, "x-validate": null }, "end_use": { "description": "Optional field specifying the end use of the goods", "enum": [ "for_resale", "not_for_resale" ], "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "objects": { "description": "List of objects/items being imported", "items": { "properties": { "country_of_origin": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "hs_code": { "description": "Harmonized System (HS) tariff code for the object", "type": "string", "x-struct": null, "x-validate": null }, "quantity": { "description": "Quantity of the object", "nullable": true, "type": "number", "x-struct": null, "x-validate": null }, "reference": { "description": "Reference identifier for the object", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "value": { "description": "Declared value of the object", "type": "string", "x-struct": null, "x-validate": null }, "value_currency": { "description": "Currency code (ISO 4217) used for the object's declared value", "nullable": true, "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "hs_code", "value", "value_currency" ], "type": "object", "x-struct": null, "x-validate": null }, "type": "array", "x-struct": null, "x-validate": null }, "origin": { "properties": { "country": { "description": "ISO 3166-1 alpha-2 country code of the origin", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "country" ], "type": "object", "x-struct": null, "x-validate": null }, "reference": { "description": "Optional reference string for identifying the estimate in your systems", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "transport": { "description": "Information about the transport method and cost", "properties": { "amount": { "description": "Total transport cost", "type": "string", "x-struct": null, "x-validate": null }, "amount_currency": { "description": "Currency code (ISO 4217) for the transport amount (optional)", "nullable": true, "type": "string", "x-struct": null, "x-validate": null }, "service_level": { "description": "Service level for transport (e.g., ups_expedited, fedex_international_first etc). Options are listed in the reference rate service levels metadata endpoint", "type": "string", "x-struct": null, "x-validate": null } }, "required": [ "amount", "amount_currency", "service_level" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "destination", "origin", "objects", "transport" ], "type": "object", "x-struct": null, "x-validate": null } }, "required": [ "import_cost_estimate" ], "title": "DirectImportCostEstimatePayload", "type": "object", "x-struct": null, "x-validate": null } } }, "info": { "contact": { "email": "hello@arta.io", "name": "Arta", "url": "https://manual.arta.io/" }, "description": "The Arta Public API provides quote generation, transport booking, and tracking capabilities. Additionally the API enables Arta partner organizations to configure email and webhook notifications for their accounts.", "termsOfService": "https://www.arta.io/legal/terms", "title": "Arta Public API", "version": "2021-01-01" }, "openapi": "3.1.0", "paths": { "/address_verifications": { "get": { "callbacks": {}, "deprecated": false, "description": "**Availability: Public Preview**\n\n_This endpoint is currently in public preview and available only to approved accounts._ _Please contact Arta to request access for your organization._\n\nRetrieve a paginated collection of address verifications belonging to your organization, sorted by creation date descending", "operationId": "addressVerifications/list", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Page number of the results to fetch.", "in": "query", "name": "page", "schema": { "default": 1, "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "Results per page (max 50)", "in": "query", "name": "page_size", "schema": { "default": 20, "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AddressVerification" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "properties": { "page": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "page_size": { "example": 20, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "total_count": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } } }, "description": "A collection of Address Verification records", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "List Address Verifications", "tags": [ "address_verifications" ] }, "post": { "callbacks": {}, "deprecated": false, "description": "**Availability: Public Preview**\n\n_This endpoint is currently in public preview and available only to approved accounts._ _Please contact Arta to request access for your organization._\n\nVerify an address and receive a corrected recommendation.", "operationId": "addressVerifications/create", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressVerificationCreate" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressVerification" } } }, "description": "The created address verification", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "400": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "BadRequest", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Bad Request", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "403": { "content": { "application/json": {} }, "description": "Forbidden" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessible entity" } }, "summary": "Create an Address Verification", "tags": [ "address_verifications" ] } }, "/address_verifications/{address_verification_id}": { "get": { "callbacks": {}, "deprecated": false, "description": "**Availability: Public Preview**\n\n_This endpoint is currently in public preview and available only to approved accounts._ _Please contact Arta to request access for your organization._\n\nRetrieve an existing address verification by its ID", "operationId": "addressVerifications/get", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "address_verification_id parameter", "in": "path", "name": "address_verification_id", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressVerification" } } }, "description": "Successful Address Verification response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Get an Address Verification", "tags": [ "address_verifications" ] } }, "/api_keys": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve a paginated collection of API Keys belonging to your Organization", "operationId": "apiKeys/list", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Page number of the results to fetch.", "in": "query", "name": "page", "schema": { "default": 1, "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "Results per page (max 50)", "in": "query", "name": "page_size", "schema": { "default": 20, "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/APIKey" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "properties": { "page": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "page_size": { "example": 20, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "total_count": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } } }, "description": "A succesful collection of API Keys associated with your organization", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "List API Keys", "tags": [ "api_keys" ] }, "post": { "callbacks": {}, "deprecated": false, "description": "You can create mulitple API keys for your organization. All API keys operate on either Live or Test modes.", "operationId": "apiKeys/create", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreate" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIKey" } } }, "description": "The created API Key", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "400": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "BadRequest", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Bad Request", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Create an API Key", "tags": [ "api_keys" ] } }, "/api_keys/{api_key_id}": { "get": { "callbacks": {}, "deprecated": false, "description": "Get an API Key", "operationId": "apiKeys/get", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "api_key_id parameter", "in": "path", "name": "api_key_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIKey" } } }, "description": "Successful API Key get response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Get an API Key", "tags": [ "api_keys" ] }, "delete": { "callbacks": {}, "deprecated": false, "description": "Delete an API Key belonging to your Organization", "operationId": "apiKeys/delete", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "api_key_id parameter", "in": "path", "name": "api_key_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "204": { "content": { "application/json": {} }, "description": "API Key deleted", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Delete an API Key", "tags": [ "api_keys" ] } }, "/attachments": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve a paginated collection of Attachment records belonging to your Organization", "operationId": "attachments/list", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Page number of the results to fetch.", "in": "query", "name": "page", "schema": { "default": 1, "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "Results per page (max 50)", "in": "query", "name": "page_size", "schema": { "default": 20, "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Attachment" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "properties": { "page": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "page_size": { "example": 20, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "total_count": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } } }, "description": "A collection of Attachment records", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "List Attachments", "tags": [ "attachments" ] }, "post": { "callbacks": {}, "deprecated": false, "description": "The attachment resource connects uploads on Arta to shipment or request resources. Attached uploads are visible in the Arta Dashobard under the \"Documents\" tab on the shipment and request detail pages.\n\nEach upload may be attached to many requests or shipments. Each request or shipment may have many associated uploads.\n\nTo create an attachment via the API you can must send an authenticated request to the `POST /attachments` endpoint with a body that includes one of two different payload schema.\n\nTo attach an upload to a shipment, the attachment payload must include `upload_id` and `shipment_id` attributes. This payload must not include a `request_id` attribute. For example:\n\n```json\n{\n \"attachment\": {\n \"shipment_id\": \"506d79b6-1e5e-4e8c-a266-74658fdaf4ee\",\n \"upload_id\": 5285\n }\n}\n```\n\nTo attach an upload to a request, the attachment payload must include `upload_id` and `request_id` attributes. This payload must not include a `shipment_id` attribute. For example:\n\n```json\n{\n \"attachment\": {\n \"request_id\": \"506d79b6-1e5e-4e8c-a266-74658fdaf4ee\",\n \"upload_id\": 5285\n }\n}\n```", "operationId": "attachments/create", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentCreate" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "The created attachment", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "400": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "BadRequest", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Bad Request", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Create an Attachment", "tags": [ "attachments" ] } }, "/attachments/{attachment_id}": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve an existing Attachment", "operationId": "attachments/get", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "attachment_id parameter", "in": "path", "name": "attachment_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } } }, "description": "Successful Attachment get response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Retrieve an Attachment", "tags": [ "attachments" ] }, "delete": { "callbacks": {}, "deprecated": false, "description": "Delete an existing Attachment", "operationId": "attachments/delete", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "attachment_id parameter", "in": "path", "name": "attachment_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "204": { "content": { "application/json": {} }, "description": "Attachment deleted", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Delete an Attachment", "tags": [ "attachments" ] } }, "/email_rules": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve a paginated collection of Email Rules belonging to your Organization", "operationId": "emailRules/list", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Page number of the results to fetch.", "in": "query", "name": "page", "schema": { "default": 1, "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "Results per page (max 50)", "in": "query", "name": "page_size", "schema": { "default": 20, "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/EmailRule" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "properties": { "page": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "page_size": { "example": 20, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "total_count": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } } }, "description": "A collection of Email Rules", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "List Email Rules", "tags": [ "email_rules" ] }, "post": { "callbacks": {}, "deprecated": false, "description": "Create an email rule to configure email notifications for your organization.", "operationId": "emailRules/create", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailRuleCreate" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailRule" } } }, "description": "The created email rule", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "400": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "BadRequest", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Bad Request", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Create an Email Rule", "tags": [ "email_rules" ] } }, "/email_rules/{email_rule_id}": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve an existing Email Rule request", "operationId": "emailRules/get", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "email_rule_id parameter", "in": "path", "name": "email_rule_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailRule" } } }, "description": "Successful Email Rule get response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Get an Email Rule", "tags": [ "email_rules" ] }, "patch": { "callbacks": {}, "deprecated": false, "description": "Update an Email Rule request", "operationId": "emailRules/update", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "email_rule_id parameter", "in": "path", "name": "email_rule_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailRuleUpdate" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailRule" } } }, "description": "The updated email rule", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Update an Email Rule", "tags": [ "email_rules" ] }, "delete": { "callbacks": {}, "deprecated": false, "description": "Delete an Email Rule", "operationId": "emailRules/delete", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "email_rule_id parameter", "in": "path", "name": "email_rule_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "204": { "content": { "application/json": {} }, "description": "Email Rule deleted", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Delete an Email Rule", "tags": [ "email_rules" ] } }, "/email_subscriptions": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve a paginated collection of Email Subscriptions belonging to your Organization", "operationId": "emailSubscriptions/list", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Page number of the results to fetch.", "in": "query", "name": "page", "schema": { "default": 1, "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "Results per page (max 50)", "in": "query", "name": "page_size", "schema": { "default": 20, "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/EmailSubscription" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "properties": { "page": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "page_size": { "example": 20, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "total_count": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } } }, "description": "A collection of Email Subscriptions", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "List Email Subscriptions", "tags": [ "email_subscriptions" ] }, "post": { "callbacks": {}, "deprecated": false, "description": "Create an email subscription to configure email notifications for your organization.", "operationId": "emailSubscriptions/create", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailSubscriptionCreate" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailSubscription" } } }, "description": "The created email subscription", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "400": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "BadRequest", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Bad Request", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Create an Email Subscription", "tags": [ "email_subscriptions" ] } }, "/email_subscriptions/{email_subscription_id}": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve an existing Email Subscription resource", "operationId": "emailSubscriptions/get", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "email_subscription_id parameter", "in": "path", "name": "email_subscription_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailSubscription" } } }, "description": "Successful Email Subscription response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Get an Email Subscription", "tags": [ "email_subscriptions" ] }, "patch": { "callbacks": {}, "deprecated": false, "description": "Update an existing Email Subscription resource", "operationId": "emailSubscriptions/update", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "email_subscription_id parameter", "in": "path", "name": "email_subscription_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailSubscriptionUpdate" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailSubscription" } } }, "description": "The updated email subscription", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Update an Email Subscription", "tags": [ "email_subscriptions" ] }, "delete": { "callbacks": {}, "deprecated": false, "description": "Delete an Email Subscription", "operationId": "emailSubscriptions/delete", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "email_subscription_id parameter", "in": "path", "name": "email_subscription_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "204": { "content": { "application/json": {} }, "description": "Email Subscription deleted", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Delete an Email Subscription", "tags": [ "email_subscriptions" ] } }, "/hosted_sessions": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve a paginated collection of hosted sessions belonging to your organization", "operationId": "hostedSessions/list", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Page number of the results to fetch.", "in": "query", "name": "page", "schema": { "default": 1, "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "Results per page (max 50)", "in": "query", "name": "page_size", "schema": { "default": 20, "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/HostedSessionListItem" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "properties": { "page": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "page_size": { "example": 20, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "total_count": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } } }, "description": "A paginated collection of hosted sessions", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "List Hosted Sessions", "tags": [ "hosted_sessions" ] }, "post": { "callbacks": {}, "deprecated": false, "description": "**Availability for Inbound Booking Sessions: Public Preview**\n\n*Inbound Booking is currently in public preview and available only to approved accounts. Please contact Arta to request access for your organization.*\n\nCreate a hosted session resource to generate an Arta Booking url.\n\nThis endpoint expects one of three types of the hosted_session schema:\n\n* **Booking Sessions**: With this schema, you must minimally include valid objects and origin details in your API call. Your customers will be able to confirm their destination details and book their preferred shipment quote. Additionally, you may provide a success_url and a cancel_url to determine where Arta will redirect the user after the session is complete.\n\n* **Inbound Booking Sessions**: With this schema, you must minimally include valid objects and destination details in your API call. Your customers will be able to confirm their origin details and book their preferred shipment quote. For Self Ship quotes, Arta will make any labels available for download. Customers may optionally review and update object dimension details in the hosted session workflow if `can_user_confirm_object_dimensions` is set to true. Additionally, you may provide a success_url and a cancel_url to determine where Arta will redirect the user after the session is complete.\n\n* **Shared Requests**: Alternatively, you may share an existing quote request by sending a `hosted_session` object with the corresponding request's request_id.\n\nUse the private url in the successful hosted session response to direct your users to the Arta Booking web page so that they may configure and book their own shipment.\n", "operationId": "hostedSessions/create", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostedSessionCreate" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostedSession" } } }, "description": "the created hosted sessions", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "400": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "BadRequest", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Bad Request", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Create a Hosted Session", "tags": [ "hosted_sessions" ] } }, "/hosted_sessions/{hosted_session_id}": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve an existing hosted session resource", "operationId": "hostedSessions/get", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "hosted_session_id parameter", "in": "path", "name": "hosted_session_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostedSession" } } }, "description": "Successful Hosted Session response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Get a Hosted Session", "tags": [ "hosted_sessions" ] } }, "/hosted_sessions/{hosted_session_id}/cancel": { "patch": { "callbacks": {}, "deprecated": false, "description": "Cancel an existing hosted session resource", "operationId": "hostedSessions/cancel", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "hosted_session_id parameter", "in": "path", "name": "hosted_session_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostedSession" } } }, "description": "Successfully cancelled Hosted Session response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Cancel a Hosted Session", "tags": [ "hosted_sessions" ] } }, "/import_cost_estimates": { "get": { "callbacks": {}, "deprecated": false, "description": "**Availability: Public Preview**\n\n_This endpoint is currently in public preview and available only to approved accounts._ _Please contact Arta to request access for your organization._\n\nRetrieve a paginated collection of import cost estimates belonging to your organization.", "operationId": "importCostEstimates/list", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Page number of the results to fetch.", "in": "query", "name": "page", "schema": { "default": 1, "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "Results per page (max 50)", "in": "query", "name": "page_size", "schema": { "default": 20, "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ImportCostEstimate" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "properties": { "page": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "page_size": { "example": 20, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "total_count": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } } }, "description": "A collection of Import Cost Estimate records", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "List Import Cost Estimates", "tags": [ "import_cost_estimates" ] }, "post": { "callbacks": {}, "deprecated": false, "description": "**Availability: Public Preview**\n\n_This endpoint is currently in public preview and available only to approved accounts._ _Please contact Arta to request access for your organization._\n\nCreate an import cost estimate to calculate cross-border duties, fees, and taxes for your international shipments.", "operationId": "importCostEstimates/create", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportCostEstimateCreate" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportCostEstimate" } } }, "description": "The created Import Cost Estimate", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "400": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "BadRequest", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Bad Request", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Create an Import Cost Estimate", "tags": [ "import_cost_estimates" ] } }, "/import_cost_estimates/{import_cost_estimate_id}": { "get": { "callbacks": {}, "deprecated": false, "description": "**Availability: Public Preview**\n\n_This endpoint is currently in public preview and available only to approved accounts._ _Please contact Arta to request access for your organization._\n\nRetrieve an existing import cost estimate record by its unique identifier.", "operationId": "importCostEstimates/get", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "import_cost_estimate_id parameter", "in": "path", "name": "import_cost_estimate_id", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportCostEstimate" } } }, "description": "Successful Import Cost Estimate response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Get an Import Cost Estimate", "tags": [ "import_cost_estimates" ] } }, "/invoice_payments": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve a paginated collection of Invoice Payments belonging to your Organization", "operationId": "invoicePayments/list", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Page number of the results to fetch.", "in": "query", "name": "page", "schema": { "default": 1, "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "Results per page (max 50)", "in": "query", "name": "page_size", "schema": { "default": 20, "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/InvoicePayment" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "properties": { "page": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "page_size": { "example": 20, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "total_count": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } } }, "description": "A collection of Invoice Payment records", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "List Invoice Payment", "tags": [ "invoice_payments" ] } }, "/invoice_payments/{invoice_payment_id}": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve an existing Invoice Payment record", "operationId": "invoicePayments/get", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "invoice_payment_id parameter", "in": "path", "name": "invoice_payment_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePayment" } } }, "description": "Successful Invoice Payment response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Get an Invoice Payment", "tags": [ "invoice_payments" ] } }, "/invoices": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve a paginated collection of Invoices belonging to your Organization", "operationId": "invoices/list", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Page number of the results to fetch.", "in": "query", "name": "page", "schema": { "default": 1, "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "Results per page (max 50)", "in": "query", "name": "page_size", "schema": { "default": 20, "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Invoice" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "properties": { "page": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "page_size": { "example": 20, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "total_count": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } } }, "description": "A collection of Invoice records", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "List Invoices", "tags": [ "invoices" ] } }, "/invoices/{invoice_id}": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve an existing Invoice record", "operationId": "invoices/get", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "invoice_id parameter", "in": "path", "name": "invoice_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" } } }, "description": "Successful Invoice response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Get an Invoice", "tags": [ "invoices" ] } }, "/logs": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve a paginated collection of Log records belonging to your Organization", "operationId": "logs/list", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Page number of the results to fetch.", "in": "query", "name": "page", "schema": { "default": 1, "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "Results per page (max 50)", "in": "query", "name": "page_size", "schema": { "default": 20, "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Log" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "properties": { "page": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "page_size": { "example": 20, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "total_count": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } } }, "description": "A collection of Log records", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "List Logs", "tags": [ "logs" ] } }, "/logs/{log_id}": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve an existing Log record", "operationId": "logs/get", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "log_id parameter", "in": "path", "name": "log_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Log" } } }, "description": "Successful Log response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Get a Log", "tags": [ "logs" ] } }, "/metadata/api_versions": { "get": { "callbacks": {}, "deprecated": false, "description": "The list of API versions supported by Arta's API.", "operationId": "metadata/apiVersions", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataApiVersion" } } }, "description": "A collection of API versions", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "API Versions", "tags": [ "metadata" ] } }, "/metadata/commercial_carriers": { "get": { "callbacks": {}, "deprecated": false, "description": "The list of commercial carriers supported by Arta's API.", "operationId": "metadata/commercialCarriers", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataCommercialCarrier" } } }, "description": "A collection of commercial carriers", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Commercial Carriers", "tags": [ "metadata" ] } }, "/metadata/currencies": { "get": { "callbacks": {}, "deprecated": false, "description": "The list of currencies supported by Arta's API.", "operationId": "metadata/currencies", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataCurrency" } } }, "description": "A collection of currency types", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Currencies", "tags": [ "metadata" ] } }, "/metadata/email_notifications": { "get": { "callbacks": {}, "deprecated": false, "description": "The list of email notification types supported by Arta's API.", "operationId": "metadata/emailNotifications", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataEmailNotification" } } }, "description": "A collection of email notification types", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Email Notifications", "tags": [ "metadata" ] } }, "/metadata/insurances": { "get": { "callbacks": {}, "deprecated": false, "description": "The list of insurance types supported by Arta's API.", "operationId": "metadata/insurances", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataInsurance" } } }, "description": "A collection of insurance types", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Insurances", "tags": [ "metadata" ] } }, "/metadata/location_access_restrictions": { "get": { "callbacks": {}, "deprecated": true, "description": "The list of location access restriction types supported by Arta's API.", "operationId": "metadata/locationAccessRestrictions", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataLocationAccessRestriction" } } }, "description": "A collection of location access restriction types", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Location Access Restrictions", "tags": [ "metadata" ] } }, "/metadata/object_components": { "get": { "callbacks": {}, "deprecated": false, "description": "The list of object component types supported by Arta's API.", "operationId": "metadata/objectComponents", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataObjectComponent" } } }, "description": "A collection of object component types", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Object Components", "tags": [ "metadata" ] } }, "/metadata/object_materials": { "get": { "callbacks": {}, "deprecated": true, "description": "The list of object material types supported by Arta's API.", "operationId": "metadata/objectMaterials", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataObjectMaterial" } } }, "description": "A collection of object material types", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Object Materials", "tags": [ "metadata" ] } }, "/metadata/objects": { "get": { "callbacks": {}, "deprecated": false, "description": "The list of object types supported by Arta's API.", "operationId": "metadata/objects", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataObject" } } }, "description": "A collection of object types", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Objects", "tags": [ "metadata" ] } }, "/metadata/package_statuses": { "get": { "callbacks": {}, "deprecated": false, "description": "The list of package status types supported by Arta's API.", "operationId": "metadata/packageStatuses", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataPackageStatus" } } }, "description": "A collection of package status types", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Package Statuses", "tags": [ "metadata" ] } }, "/metadata/packings": { "get": { "callbacks": {}, "deprecated": false, "description": "The list of packing types supported by Arta's API.", "operationId": "metadata/packings", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataPacking" } } }, "description": "A collection of packing types", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Packings", "tags": [ "metadata" ] } }, "/metadata/parcel_transport_services": { "get": { "callbacks": {}, "deprecated": false, "description": "The list of parcel transport service types supported by Arta's API.", "operationId": "metadata/parcelTransportServices", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataParcelTransportService" } } }, "description": "A collection of parcel transport service types", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Parcel Transport Services", "tags": [ "metadata" ] } }, "/metadata/payment_process_types": { "get": { "callbacks": {}, "deprecated": false, "description": "The list of payment process types supported by Arta's API.", "operationId": "metadata/paymentProcessTypes", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataPaymentProcessType" } } }, "description": "A collection of shipment Payment Process types", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Payment Process Types", "tags": [ "metadata" ] } }, "/metadata/quotes": { "get": { "callbacks": {}, "deprecated": false, "description": "The list of Quote types provided by Arta.", "operationId": "metadata/quotes", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataQuote" } } }, "description": "A collection of quote types", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Quote Types", "tags": [ "metadata" ] } }, "/metadata/quoting_strategies": { "get": { "callbacks": {}, "deprecated": false, "description": "The list of quoting strategies supported by Arta.", "operationId": "metadata/quotingStrategies", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataQuotingStrategy" } } }, "description": "A collection of quoting strategies", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Quoting Strategies", "tags": [ "metadata" ] } }, "/metadata/reference_rate_providers": { "get": { "callbacks": {}, "deprecated": false, "description": "The list of reference rate providers supported by Arta's API.", "operationId": "metadata/referenceRateProviders", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataReferenceRateProvider" } } }, "description": "A collection of reference rate providers", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Reference Rate Providers", "tags": [ "metadata" ] } }, "/metadata/reference_rate_service_levels": { "get": { "callbacks": {}, "deprecated": false, "description": "The list of reference rate service levels supported by Arta's API.", "operationId": "metadata/referenceRateServiceLevels", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataReferenceRateServiceLevel" } } }, "description": "A collection of reference rate service levels", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Reference Rate Service Levels", "tags": [ "metadata" ] } }, "/metadata/request_statuses": { "get": { "callbacks": {}, "deprecated": false, "description": "The list of statuses for a quote request resources.", "operationId": "metadata/requestStatuses", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataRequestStatus" } } }, "description": "A collection of quote request statuses", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Quote Request Statuses", "tags": [ "metadata" ] } }, "/metadata/services": { "get": { "callbacks": {}, "deprecated": false, "description": "The list of shipment services supported by Arta's API.", "operationId": "metadata/services", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataService" } } }, "description": "A collection of service types", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Services", "tags": [ "metadata" ] } }, "/metadata/shipment_exception_types": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve the list of shipment exception types", "operationId": "metadata/shipmentExceptionTypes", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataShipmentExceptionType" } } }, "description": "A collection of shipment exception types", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Shipment Exception Types", "tags": [ "metadata" ] } }, "/metadata/shipment_statuses": { "get": { "callbacks": {}, "deprecated": false, "description": "The list of statuses for a shipment on Arta.", "operationId": "metadata/shipmentStatuses", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataShipmentStatus" } } }, "description": "A collection of shipment statuses", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Shipment Statuses", "tags": [ "metadata" ] } }, "/organization": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve the Organization associated with the API Key in the Authorization header", "operationId": "organization-get", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" } } }, "description": "Successful Organization response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Get an Organization", "tags": [ "organization" ] }, "patch": { "callbacks": {}, "deprecated": false, "description": "Update the Organization associated with the API Key in the Authorization header", "operationId": "organization-patch", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationUpdate" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" } } }, "description": "Successful Organization update response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Update an Organization", "tags": [ "organization" ] } }, "/payments": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve a paginated collection of Payments belonging to your Organization", "operationId": "payments/list", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Page number of the results to fetch.", "in": "query", "name": "page", "schema": { "default": 1, "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "Results per page (max 50)", "in": "query", "name": "page_size", "schema": { "default": 20, "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Payment" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "properties": { "page": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "page_size": { "example": 20, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "total_count": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } } }, "description": "A collection of Payment records", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "List Payments", "tags": [ "payments" ] } }, "/payments/{payment_id}": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve an existing Payment record", "operationId": "payments/get", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "payment_id parameter", "in": "path", "name": "payment_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment" } } }, "description": "Successful Payment response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Get a Payment", "tags": [ "payments" ] } }, "/requests": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve a paginated collection of Quote Request records belonging to your Organization", "operationId": "requests/list", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Page number of the results to fetch.", "in": "query", "name": "page", "schema": { "default": 1, "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "Results per page (max 50)", "in": "query", "name": "page_size", "schema": { "default": 20, "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "An optional structured search query", "in": "query", "name": "search", "required": false, "schema": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/RequestListItem" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "properties": { "page": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "page_size": { "example": 20, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "total_count": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } } }, "description": "A collection of Quote Request records", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "List Quote Requests", "tags": [ "requests" ] }, "post": { "callbacks": {}, "deprecated": false, "description": "The first step to booking a shipment on Arta is to create a Quote Request. This quote request provides Arta with all the necessary transport details for us to price your eventual shipment. \n\n Arta will return eligible quotes for your shipment across Arta's Premium, Selecct, and Parcel quote types. If any quote types are ineligible given your logistic details, those will be noted in the `disqualifications` response. \n\n You must minimally include `objects`, `origin`, and `destination` details in your API call for Arta to successfully price the transport.", "operationId": "requests/create", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Optionally set a timeout boundary in milliseconds for creating quote requests.\n\nWhile Arta takes great care to return quotes quickly, several external services consumed during the process of creating quotes have varying response times. The `Arta-Quote-Timeout` header is particularly useful if your integration requires requests to return within a given time frame. When the timeout is reached, the Arta API will stop any tasks in progress and return the quotes that have already been completed. If building quotes for a particular quote type is incomplete at timeout, the API will return a disqualification message for that quote type with a `client_timeout_reached` `reason_code`.", "example": 6000, "in": "header", "name": "Arta-Quote-Timeout", "required": false, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestCreate" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Request" } } }, "description": "response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "400": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "BadRequest", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Bad Request", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Create a Quote Request", "tags": [ "requests" ] } }, "/requests/{request_id}": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve an existing Quote Request record by its ID", "operationId": "requests/get", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "request_id parameter", "in": "path", "name": "request_id", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Request" } } }, "description": "Successful Request get response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Get a Quote Request", "tags": [ "requests" ] } }, "/requests/{request_id}/cancel": { "patch": { "callbacks": {}, "deprecated": false, "description": "Cancels an in_progress Quote Request resource. This is useful to indicate to Arta that you no longer require custom quotes for a request.", "operationId": "requests/cancel", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "request_id parameter", "in": "path", "name": "request_id", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Request" } } }, "description": "Successful Request get response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Cancel a Quote Request", "tags": [ "requests" ] } }, "/requests/{request_id}/contacts": { "patch": { "callbacks": {}, "deprecated": false, "description": "For quote requests with a current status of `quoted` or `disqualified`, you may update the contacts associated with either or both of the origin and destination locations.\n\nCompleting the missing contact details for a previously unbookable quote request may change the bookable status for the request if all other requirements are met.\n\nThis endpoint payload requires at least one of a destination or an origin object to be present.", "operationId": "requests/update/contacts", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "request_id parameter", "in": "path", "name": "request_id", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestUpdateContacts" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Request" } } }, "description": "Successful Request get response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Update the contacts for a Quote Request", "tags": [ "requests" ] } }, "/requests/{request_id}/custom": { "patch": { "callbacks": {}, "deprecated": false, "description": "Convert an existing Quote Request into a Custom Quote Request.", "operationId": "requests/custom", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "request_id parameter", "in": "path", "name": "request_id", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestUpdateCustom" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Request" } } }, "description": "Successful Request get response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Request custom quotes", "tags": [ "requests" ] } }, "/self_ship_collection_availability_checks": { "post": { "callbacks": {}, "deprecated": false, "description": "**Availability: Public Preview**\n\n_This endpoint is currently in public preview and available only to approved accounts._ _Please contact Arta to request access for your organization._\n\nCheck carrier pickup availability for a given location, service, and date", "operationId": "selfShipCollectionAvailabilityChecks/create", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelfShipCollectionAvailabilityCheckCreate" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelfShipCollectionAvailabilityCheck" } } }, "description": "Available pickup slots for the given parameters", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "400": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "BadRequest", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Bad Request", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "403": { "content": { "application/json": {} }, "description": "Forbidden" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable entity" } }, "summary": "Check Self-Ship Collection Availability", "tags": [ "self_ship_collections" ] } }, "/self_ship_collections": { "get": { "callbacks": {}, "deprecated": false, "description": "**Availability: Public Preview**\n\n_This endpoint is currently in public preview and available only to approved accounts._ _Please contact Arta to request access for your organization._\n\nRetrieve a paginated collection of self-ship collection records belonging to your organization, sorted by most recent first", "operationId": "selfShipCollections/list", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Page number of the results to fetch.", "in": "query", "name": "page", "schema": { "default": 1, "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "Results per page (max 50)", "in": "query", "name": "page_size", "schema": { "default": 20, "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SelfShipCollection" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "properties": { "page": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "page_size": { "example": 20, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "total_count": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } } }, "description": "A collection of Self-Ship Collection records", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "List Self-Ship Collections", "tags": [ "self_ship_collections" ] }, "post": { "callbacks": {}, "deprecated": false, "description": "**Availability: Public Preview**\n\n_This endpoint is currently in public preview and available only to approved accounts._ _Please contact Arta to request access for your organization._\n\nSchedule a carrier pickup for a self-ship shipment", "operationId": "selfShipCollections/create", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelfShipCollectionCreate" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelfShipCollection" } } }, "description": "The created self-ship collection", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "400": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "BadRequest", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Bad Request", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "403": { "content": { "application/json": {} }, "description": "Forbidden" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable entity" } }, "summary": "Create a Self-Ship Collection", "tags": [ "self_ship_collections" ] } }, "/self_ship_collections/{self_ship_collection_id}": { "get": { "callbacks": {}, "deprecated": false, "description": "**Availability: Public Preview**\n\n_This endpoint is currently in public preview and available only to approved accounts._ _Please contact Arta to request access for your organization._\n\nRetrieve an existing self-ship collection by its ID", "operationId": "selfShipCollections/get", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "self_ship_collection_id parameter", "in": "path", "name": "self_ship_collection_id", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelfShipCollection" } } }, "description": "Successful Self-Ship Collection response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Get a Self-Ship Collection", "tags": [ "self_ship_collections" ] } }, "/shipment_exceptions": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve a paginated collection of Shipment Exceptions belonging to your Organization", "operationId": "shipmentExceptions/list", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Page number of the results to fetch.", "in": "query", "name": "page", "schema": { "default": 1, "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "Results per page (max 50)", "in": "query", "name": "page_size", "schema": { "default": 20, "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ShipmentException" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "properties": { "page": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "page_size": { "example": 20, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "total_count": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } } }, "description": "A paginated collection of Shipment Exceptions", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "List Shipment Exceptions", "tags": [ "shipment_exceptions" ] }, "post": { "callbacks": {}, "deprecated": false, "description": "Create a Shipment Exception for a Shipment\n\n* Clients can create shipment exceptions of a single type currently:`requested_hold_to_collect` \n\n* A shipment must have a `pending` or `confirmed` status to create a `requested_hold_to_collect` shipment exception. \n\n* `hold_until` date cannot be greater than 30 days from the associated shipment's `created_at` timestamp.", "operationId": "shipmentExceptions/create", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentExceptionCreate" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentException" } } }, "description": "Successful response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Create Shipment Exception", "tags": [ "shipment_exceptions" ] } }, "/shipment_exceptions/{shipment_exception_id}": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve an existing Shipment Exception", "operationId": "shipmentExceptions/get", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "shipment_exception_id parameter", "in": "path", "name": "shipment_exception_id", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentException" } } }, "description": "Successful Shipment Exception response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Get a Shipment Exception", "tags": [ "shipment_exceptions" ] }, "patch": { "callbacks": {}, "deprecated": false, "description": "Update an existing Shipment Exception", "operationId": "shipmentExceptions/update", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "shipment_exception_id parameter", "in": "path", "name": "shipment_exception_id", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentExceptionUpdate" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentException" } } }, "description": "Successful Shipment Exception response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Update a Shipment Exception", "tags": [ "shipment_exceptions" ] } }, "/shipments": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve a paginated collection of Shipment records belonging to your Organization", "operationId": "shipments/list", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Page number of the results to fetch.", "in": "query", "name": "page", "schema": { "default": 1, "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "Results per page (max 50)", "in": "query", "name": "page_size", "schema": { "default": 20, "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "An optional structured search query", "in": "query", "name": "search", "required": false, "schema": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ShipmentList" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "properties": { "page": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "page_size": { "example": 20, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "total_count": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } } }, "description": "A collection of Shipment records", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "List Shipments", "tags": [ "shipments" ] }, "post": { "callbacks": {}, "deprecated": false, "description": "This endpoint is used for two purposes:\n\n**1. Generating standard Arta shipments**\n\nAll [standard shipments](https://manual.arta.io/guides/logistics/workflow) are actively facilitated by Arta. Working in tandem with our extensive logistics carrier network, Arta fulfills shipments with `Premium`, `Select`, and `Parcel` quote types from scheduling collection, to coordinating packing, through delivery. For shipments with the `Self Ship` quote type, Arta will generate labels on your behalf with commercial carriers such as FedEx, UPS, and DHL.\n\nTo book a standard Arta shipment, you must first create a shipping quote request. You can then use a `quote_id` returned by the quote request endpoint to create the shipment.\n\n_Deferring label purchase on self-ship shipments_\n\nFor self-ship shipments, you may optionally pass an `exceptions` array in the request body to apply exceptions at booking time. Currently, the only supported booking-time exception type is `label_hold`.\n\nWhen a `label_hold` exception is requested, Arta will skip automatic label purchase for the shipment. Once the exception is resolved, the self-ship label automation pipeline is re-triggered.\n\n**2. Generating Track shipments**\n\n[Track shipments](https://manual.arta.io/guides/solutions/no-code/post-sale/tracking/track) provide a similar customer tracking and notification experience as standard Arta shipments but for shipments you have booked with commercial carriers outside of the Arta platform.\n\nTo create a Track shipment, you provide the `carrier` and `tracking_number` purchased externally and the Arta platform provides status automation, tracking pages, and customer notifications. You may optionally provide additional supplementary information such as origin, destination, and package details for Track shipments.\n\n_Note that Track shipments are a beta feature. Please contact your account manager or hello@arta.io to request access for your organization._", "operationId": "shipments/create", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentCreate" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } }, "description": "The created shipment", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "400": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "BadRequest", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Bad Request", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "403": { "content": { "application/json": {} }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessible entity" } }, "summary": "Create a Shipment", "tags": [ "shipments" ] } }, "/shipments/{shipment_id}": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve an existing Shipment record", "operationId": "shipments/get", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "shipment_id parameter", "in": "path", "name": "shipment_id", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } }, "description": "Successful Shipment get response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Retrieve a Shipment", "tags": [ "shipments" ] } }, "/tags": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve a paginated collection of tags belonging to your organization\n\nTags allow you to categorize and organize Shipments, Requests, and other resources for easier tracking and filtering. They can be created, updated, and archived by setting is_active to false. Archived tags remain linked to existing records but cannot be associated with new ones. If needed, tags can be reactivated later.\n\nTags are global for an organization and shared across both Live and Test modes.", "operationId": "tags/list", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Page number of the results to fetch.", "in": "query", "name": "page", "schema": { "default": 1, "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "Results per page (max 50)", "in": "query", "name": "page_size", "schema": { "default": 20, "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "An optional structured search query", "in": "query", "name": "search", "required": false, "schema": { "nullable": true, "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Tag" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "properties": { "page": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "page_size": { "example": 20, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "total_count": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } } }, "description": "A collection of Tag records", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "List Tags", "tags": [ "tags" ] }, "post": { "callbacks": {}, "deprecated": false, "description": "Create a new tag for your organization.", "operationId": "tags/create", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagCreate" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tag" } } }, "description": "The created tag", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "400": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "BadRequest", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Bad Request", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "403": { "content": { "application/json": {} }, "description": "Forbidden" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessible entity" } }, "summary": "Create a Tag", "tags": [ "tags" ] } }, "/tags/{tag_name}": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve an existing Tag resource by name", "operationId": "tags/get", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "The name field for a Tag resource", "in": "path", "name": "tag_name", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tag" } } }, "description": "Successful Tag response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Get a Tag", "tags": [ "tags" ] }, "patch": { "callbacks": {}, "deprecated": false, "description": "Update an existing Tag resource", "operationId": "tags/update", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "The name field for a Tag resource", "in": "path", "name": "tag_name", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagUpdate" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tag" } } }, "description": "The updated tag", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Update a Tag", "tags": [ "tags" ] } }, "/trackings/{tracking_number}": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve Tracking details for a parcel shipment by tracking number", "operationId": "trackings/get", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "tracking_number parameter", "in": "path", "name": "tracking_number", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tracking" } } }, "description": "Successful Tracking response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Get Tracking Details", "tags": [ "trackings" ] } }, "/uploads": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve a paginated collection of Uploads belonging to your Organization", "operationId": "uploads/list", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Page number of the results to fetch.", "in": "query", "name": "page", "schema": { "default": 1, "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "Results per page (max 50)", "in": "query", "name": "page_size", "schema": { "default": 20, "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Upload" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "properties": { "page": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "page_size": { "example": 20, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "total_count": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } } }, "description": "A collection of Upload records", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "List Uploads", "tags": [ "uploads" ] }, "post": { "callbacks": {}, "deprecated": false, "description": "Uploading a file to Arta via API is a two step process.\n\nThe first step is to make an authenticated HTTP request to the `POST /uploads` endpoint described here. Successful requests to this endpoint will create an upload resource with a \"pending\" `status` as well as a `presigned_url` attribute. \n\nThe second step is to create a `PUT` HTTP request to the URL defined in the `presigned_url` field of the successful create response. This second request must include the raw data of the file as the request `body` and a `content-type` header. The `content-type` header must match the `mime_type` provided in your initial request. The size of the raw data must match the `size` param provided in your initial request.\n\nFor example, if you provided a `mime_type` of `text/csv` and a `size` of `13` bytes in the initial request to create the resource and if it successfully responded with a `presigned_url` value of `https://cdn.arta.io/uploads/my-file.csv`, your second request will look something like the following:\n\n```\ncurl --location --request PUT 'https://cdn.arta.io/uploads/my-file.csv' \\\n--header 'Content-Type: text/csv' \\\n--data-raw 'hello,world,\n'\n```", "operationId": "uploads/create", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadCreate" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadWithPresignedURL" } } }, "description": "response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "400": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "BadRequest", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Bad Request", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Create an Upload", "tags": [ "uploads" ] } }, "/uploads/{upload_id}": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve an existing Upload", "operationId": "uploads-get", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "upload_id parameter", "in": "path", "name": "upload_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Upload" } } }, "description": "Successful Upload response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Get an Upload", "tags": [ "uploads" ] }, "delete": { "callbacks": {}, "deprecated": false, "description": "Delete an Upload", "operationId": "uploads/delete", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "upload_id parameter", "in": "path", "name": "upload_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "204": { "content": { "application/json": {} }, "description": "No content" }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Delete an Upload", "tags": [ "uploads" ] } }, "/webhook_deliveries": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve a paginated collection of Webhook Deliveries belonging to your Organization", "operationId": "webhookDeliveries/list", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Page number of the results to fetch.", "in": "query", "name": "page", "schema": { "default": 1, "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "Results per page (max 50)", "in": "query", "name": "page_size", "schema": { "default": 20, "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/WebhookDeliveryListItem" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "properties": { "page": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "page_size": { "example": 20, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "total_count": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } } }, "description": "A collection of Webhook Deliveries", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "List Webhook Deliveries", "tags": [ "webhook_deliveries" ] } }, "/webhook_deliveries/{webhook_delivery_id}": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve an existing Webhook Delivery", "operationId": "webhookDeliveries-get", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "webhook_delivery_id parameter", "in": "path", "name": "webhook_delivery_id", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDelivery" } } }, "description": "Successful Webhook Delivery response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Get a Webhook Delivery", "tags": [ "webhook_deliveries" ] } }, "/webhooks": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve a paginated collection of Webhooks belonging to your Organization", "operationId": "webhooks/list", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "Page number of the results to fetch.", "in": "query", "name": "page", "schema": { "default": 1, "type": "integer", "x-struct": null, "x-validate": null } }, { "description": "Results per page (max 50)", "in": "query", "name": "page_size", "schema": { "default": 20, "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Webhook" }, "type": "array", "x-struct": null, "x-validate": null }, "metadata": { "properties": { "page": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "page_size": { "example": 20, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null }, "total_count": { "example": 1, "format": "int64", "readOnly": true, "type": "integer", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } } }, "description": "A collection of Webhooks", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "List Webhooks", "tags": [ "webhooks" ] }, "post": { "callbacks": {}, "deprecated": false, "description": "Create a new webhook for your organization.", "operationId": "webhooks/create", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookCreate" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } }, "description": "The created webhook", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "400": { "content": { "application/json": {} }, "description": "Bad Request" } }, "summary": "Create a Webhook", "tags": [ "webhooks" ] } }, "/webhooks/{webhook_id}": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve an existing Webhook request", "operationId": "webhooks-get", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "webhook_id parameter", "in": "path", "name": "webhook_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } }, "description": "Successful Webhook response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Get a Webhook", "tags": [ "webhooks" ] }, "patch": { "callbacks": {}, "deprecated": false, "description": "Update an existing Webhook request", "operationId": "webhooks/patch", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "webhook_id parameter", "in": "path", "name": "webhook_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookUpdate" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } }, "description": "Successful Webhook response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Update a Webhook", "tags": [ "webhooks" ] }, "delete": { "callbacks": {}, "deprecated": false, "description": "Delete a Webhook", "operationId": "webhooks/delete", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "webhook_id parameter", "in": "path", "name": "webhook_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "204": { "content": { "application/json": {} }, "description": "No content" }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Delete a Webhook", "tags": [ "webhooks" ] } }, "/webhooks/{webhook_id}/ping": { "post": { "callbacks": {}, "deprecated": false, "description": "Trigger Arta to deliver a test message to an existing Webhook endpoint", "operationId": "webhooks-post", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "webhook_id parameter", "in": "path", "name": "webhook_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } }, "description": "Successful Webhook response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Ping a Webhook", "tags": [ "webhooks" ] } }, "/webhooks/{webhook_id}/secret_token": { "get": { "callbacks": {}, "deprecated": false, "description": "Retrieve the secret token associated with a webhook endpoint resource", "operationId": "webhooks-secret-token-get", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "webhook_id parameter", "in": "path", "name": "webhook_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSecretToken" } } }, "description": "Successful Webhook response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Get a Web Hook Secret Token", "tags": [ "webhooks" ] } }, "/webhooks/{webhook_id}/secret_token/reset": { "patch": { "callbacks": {}, "deprecated": false, "description": "Regenerate the secret token associated with a webhook endpoint resource", "operationId": "webhooks-secret-token-reset-patch", "parameters": [ { "description": "Authorize your API calls with an Arta API token", "example": "ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y", "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string", "x-struct": null, "x-validate": null } }, { "description": "webhook_id parameter", "in": "path", "name": "webhook_id", "required": true, "schema": { "type": "integer", "x-struct": null, "x-validate": null } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSecretToken" } } }, "description": "Successful Webhook response", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } }, "404": { "content": { "application/json": { "schema": { "properties": { "errors": { "properties": { "detail": { "example": "string", "type": "string", "x-struct": null, "x-validate": null } }, "type": "object", "x-struct": null, "x-validate": null } }, "title": "NotFound", "type": "object", "x-struct": null, "x-validate": null } } }, "description": "Not Found", "headers": { "content-type": { "example": "application/json", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" }, "x-arta-request-id": { "description": "A unique identifier for the Arta API call", "example": "FkBjuxbwLLTx4RoAARkx", "schema": { "type": "string", "x-struct": null, "x-validate": null }, "style": "simple" } } } }, "summary": "Reset a Web Hook Secret Token", "tags": [ "webhooks" ] } } }, "security": [], "servers": [ { "url": "https://api.arta.io", "variables": {} } ], "tags": [], "x-topics": [ { "content": "The Arta API accepts server-to-server communications authenticated by API keys. Your API keys are self-managed and unique to your organization.\n\nUsing your API key to authenticate an API call is straightforward. Simply include your API Key token in the Authorization header of every call made to the system. This is the only place that it is accepted.", "example": "```shell\n\n$ curl \\ \n\n -X GET https://api.arta.io/shipments \\ \n\n -H \"Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y\"", "title": "Authentication" }, { "content": "Arta imposes rate limits on API requests to maintain system stability and ensure fair usage. If you exceed these limits, the API will return a `429 Too Many Requests` error. Below are the rate limits for both Live and Test modes.\n\n**Live Mode:**\n\n*\tConcurrent requests: 15 API calls at the same time (any type)\n* Instant quote requests: 20 calls per minute\n* Overall requests: 1000 API calls per minute (any type)\n\n**Test Mode:**\n\n* Concurrent requests: 10 API calls at the same time (any type)\n* Instant quote requests: 10 calls per minute\n* Overall requests: 500 API calls per minute (any type)\n\nWhen a rate limit is exceeded, we recommend implementing retry logic with exponential backoff to handle 429 errors effectively.", "title": "Rate Limits" }, { "content": "The Arta API supports flexible search functionality across multiple resources, including Shipments, Requests, Hosted Sessions, Tags, and others. Using the search query parameter, you can construct structured queries to filter results based on specific criteria.\n\nKey features of the search functionality include:\n\n* Support for negation, wildcards, numeric filters, and date comparisons.\n* Each search query consists of one or more clauses, where each clause contains a `field`, an operator, and a `value`.\n* Clauses operating on the same field are combined using OR logic, while clauses across different fields are combined using AND logic.\n\n* Use quotation marks to keep multi-word search terms together.\n\nThis allows for powerful and precise filtering to retrieve the exact data you need from the API.\n\n**Syntax and operators**\n\nThe following table lists the operators and syntax that you can use to construct a search query clause.\n\n| Operator | Usage | Description | Examples |\n|------------|--------------------------------|-----------------------------------------------------------------------------|---------------------------------------------------------------------|\n| `:` | `field:value` | Exact match operator (case insensitive) | `status:pending` returns records where the status is `pending` |\n| `*` | `value*` | Use an asterisk (wildcard operator) at the end of a term to match fields that start with the fragment | `art*` returns records that match \"arta\" and \"artist\" but not \"smart\" |\n| `*` | `*value` | Use an asterisk at the start of a term to match fields that end with the fragment | `*art` returns \"smart\" but not \"martian\" |\n| `-` | `-field:value` | Returns records that don’t match the clause | `-status:pending` returns records that do not have a status of pending |\n| `>, <, =` | `field:value`, `field:>=value`, `field:<=value` | Greater than/less than operators | `created-at:<=2021-01-01` returns records from the beginning of time through January 1, 2021 |\n| `..` | `field:value1..value2` | Filters for values within a given range where the first number is the lowest value and the second is the highest | `created-at:2021-05-01..2021-05-15` returns records where the `created_at` field is between May 1, 2021 and May 15, 2021 |\n\n\n\n**Hosted Session search fields**\n\n| Field | Type |\n|------------|--------------|\n| `created-at` | date |\n| `destination-address-line-1` | string |\n| `destination-city` | string |\n| `destination-contacts-emails` | string |\n| `destination-contacts-names` | string |\n| `destination-contacts-phone-numbers` | string |\n| `destination-country` | string |\n| `destination-postal-code` | string |\n| `destination-region` | string |\n| `insurance` | string |\n| `internal-reference` | string |\n| `object-creators` | string |\n| `object-descriptions` | string |\n| `object-internal-references` | string |\n| `object-public-references` | string |\n| `object-titles` | string |\n| `origin-address-line-1` | string |\n| `origin-city` | string |\n| `origin-contacts-emails` | string |\n| `origin-contacts-names` | string |\n| `origin-contacts-phone-numbers` | string |\n| `origin-country` | string |\n| `origin-postal-code` | string |\n| `origin-region` | string |\n| `public-reference` | string |\n| `quote-type` | string |\n| `shipping-notes` | string |\n| `shortcode` | string |\n| `status` | string |\n| `type` | string |\n| `tags` | string |\n\n**Request search fields**\n\n| Field | Type |\n|------------|--------------|\n| `bookable` | string |\n| `created-at` | date |\n| `destination-address-line-1` | string |\n| `destination-city` | string |\n| `destination-contacts-emails` | string |\n| `destination-contacts-names` | string |\n| `destination-contacts-phone-numbers` | string |\n| `destination-country` | string |\n| `destination-postal-code` | string |\n| `destination-region` | string |\n| `hosted-session` | string |\n| `internal-reference` | string |\n| `object-creators` | string |\n| `object-descriptions` | string |\n| `object-internal-references` | string |\n| `object-public-references` | string |\n| `object-titles` | string |\n| `origin-address-line-1` | string |\n| `origin-city` | string |\n| `origin-contacts-emails` | string |\n| `origin-contacts-names` | string |\n| `origin-contacts-phone-numbers` | string |\n| `origin-country` | string |\n| `origin-postal-code` | string |\n| `origin-region` | string |\n| `public-reference` | string |\n| `quote-type` | string |\n| `shipping-notes` | string |\n| `shortcode` | string |\n| `status` | string |\n| `tags` | string |\n\n**Shipment search fields**\n\n| Field | Type |\n|------------|--------------|\n| `created-at` | date |\n| `destination-address-line-1` | string |\n| `destination-city` | string |\n| `destination-contacts-emails` | string |\n| `destination-contacts-names` | string |\n| `destination-contacts-phone-numbers` | string |\n| `destination-country` | string |\n| `destination-postal-code` | string |\n| `destination-region` | string |\n| `eei-form-status` | string |\n| `hosted-session` | string |\n| `internal-reference` | string |\n| `object-creators` | string |\n| `object-descriptions` | string |\n| `object-internal-references` | string |\n| `object-public-references` | string |\n| `object-titles` | string |\n| `origin-address-line-1` | string |\n| `origin-city` | string |\n| `origin-contacts-emails` | string |\n| `origin-contacts-names` | string |\n| `origin-contacts-phone-numbers` | string |\n| `origin-country` | string |\n| `origin-postal-code` | string |\n| `origin-region` | string |\n| `public-reference` | string |\n| `quote-type` | string |\n| `request-shortcode` | string |\n| `shipping-notes` | string |\n| `shortcode` | string |\n| `status` | string |\n| `tags` | string |\n| `total` | numeric |\n| `total-currency` | string |\n| `tracking-numbers` | string |\n\n**Tag search fields**\n\n| Field | Type |\n|------------|--------------|\n| `color` | string |\n| `description` | string |\n| `is_active` | string |\n| `name` | string |\n\n", "title": "Search" } ] }