Cancel a Quote Request

PATCH /requests/{request_id}/cancel

Cancels an in_progress Quote Request resource. This is useful to indicate to Arta that you no longer require custom quotes for a request.

Headers

  • Authorization string Required

    Authorize your API calls with an Arta API token

Path parameters

Responses

  • 200 application/json

    Successful Request get response

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • additional_services array[string]

      The id of a service.

    • bookable object
      Hide bookable attributes Show bookable attributes
      • ready boolean

        Returns true if the quotes in this request may be booked

      • missing array[string]

        A list of fields required for the request to be bookable

    • A NaiveDatetime-formatted timestamp describing when the resource was created with microsecond precision

    • currency string

      ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

      Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z]{3}$. Default value is USD.

    • Hide destination attributes Show destination attributes
    • disqualifications array[object]

      The list of reasons for which particular quote types were disqulified

      Hide disqualifications attributes Show disqualifications attributes object

      The disqualifcation reason

    • hosted_session_id integer | null

      The ID of the HostedSession through which this shipment was created

    • id string
    • insurance string | null

      The id of an insurance type. If requesting Arta insurance, object values must be provided.

    • internal_reference string | null

      This field can be used to pass through any data about the request you may want returned unaltered for your own later usage

      Maximum length is 255.

    • The request ID for the API call that created the resource. This request ID maps to the Log resource's "request_id" field

    • The count of objects included in the initial request payload

    • objects array[object]
      Hide objects attributes Show objects attributes object
      • current_packing array[string]

        A list of packing subtype IDs describing how the item is currently packed. Options are defined in the Packing Types metadata endpoint

      • depth string

        The depth of the object

      • details object
        Hide details attributes Show details attributes
        • creation_date string | null

          Details about the timing in which an object was created

        • creator string

          The creator of the object

        • is_cites boolean

          Set to true if the object is governed by the Convention on International Trade in Endangered Species of Wild Fauna and Flora

          Default value is false.

        • is_fragile boolean

          Set this flag to true is the item is fragile. This may effect packing and handling costs

          Default value is false.

        • materials array[string] Deprecated

          A list of IDs describing the types of materials used. Options are defined in the Object Materials metadata endpoint

        • notes string

          Any notes about the object

        • title string

          The object title

      • height string

        The height of the object

      • id integer

        The system-generated ID for this object

      • images array[string(uri)]

        A list image urls of the object

      • internal_reference string | null

        This field can be used to pass through any data about the object you may want returned unaltered for your own later usage

        Maximum length is 255.

      • public_reference string | null

        A user defined name of the object

        Maximum length is 255.

      • subtype string

        The object subtype id

        Format should match the following pattern: ^[0-9a-z_]{1,56}$.

      • type string

        The object type id

        Format should match the following pattern: ^[0-9a-z_]{1,56}$.

      • width string

        The width of the object

      • weight string

        The height of the object

      • Values are in or cm.

      • value string

        Format should match the following pattern: ^(0|([1-9]+[0-9]*))(\.[0-9]{1,2})?$.

      • ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

        Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z]{3}$. Default value is USD.

    • origin object
      Hide origin attributes Show origin attributes
    • The primary method by which payment to Arta will be handled for any shipment booked from this request

      Maximum length is 255. Values are checkout or invoicing.

    • An optional field presenting the list of quote types the caller instructed Arta to return as part of the quote request

    • public_reference string | null

      A client defined name for the resource. The value provided for the public_reference field may appear in notification emails and public web pages

      Maximum length is 255.

    • quote_types array[string]

      The id of a quote type

    • quotes array[object]

      The list of quotes returned for the request

      Hide quotes attributes Show quotes attributes object
      • id integer
      • Hide included_insurance_policy attributes Show included_insurance_policy attributes
        • amount string

          Format should match the following pattern: ^(0|([1-9]+[0-9]*))(\.[0-9]{1,2})?$.

        • ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

          Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z]{3}$. Default value is USD.

        • id string
        • Format should match the following pattern: ^(0|([1-9]+[0-9]*))(\.[0-9]{1,2})?$.

        • ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

          Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z]{3}$. Default value is USD.

      • included_services array[object]
        Hide included_services attributes Show included_services attributes object
      • optional_services array[object]
        Hide optional_services attributes Show optional_services attributes object
        • amount string

          Format should match the following pattern: ^(0|([1-9]+[0-9]*))(\.[0-9]{1,2})?$.

        • ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

          Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z]{3}$. Default value is USD.

        • included_services array[object]
          Hide included_services attributes Show included_services attributes object
        • name string
        • subtype string
        • type string
      • status string
      • total string

        Format should match the following pattern: ^(0|([1-9]+[0-9]*))(\.[0-9]{1,2})?$.

      • ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

        Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z]{3}$. Default value is USD.

    • shipping_notes string | null

      This field can be used to pass through any notes to Arta that a customer might want to provide about the request

    • A brief and unique string identifier for the request resource

    • status string

      Values are quoted, in_progress, cancelled, closed, disqualified, expired, or pending.

    • A NaiveDatetime-formatted timestamp describing when the resource was last updated with microsecond precision

  • 404 application/json

    Resource Not Found

    Hide headers attributes Show headers attributes
    Hide response attribute Show response attribute object

    Basic Error

PATCH /requests/{request_id}/cancel
curl \
 -X PATCH https://api.arta.io/requests/{request_id}/cancel \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response examples (200)
{
  "id": "9d8892bc-f4c6-4b45-88e2-0ccd28eb73cc",
  "origin": {
    "city": "New York",
    "title": "Warehouse",
    "region": "NY",
    "country": "US",
    "contacts": [
      {
        "name": "Mary Quinn Sullivan",
        "phone_number": "(333) 333-3333",
        "email_address": "mary@example.com"
      }
    ],
    "postal_code": "10019",
    "address_line_1": "11 W 53rd St",
    "address_line_2": null,
    "address_line_3": null,
    "access_restrictions": []
  },
  "quotes": [
    {
      "id": 61,
      "total": "2",
      "status": "published",
      "quote_type": "premium",
      "total_currency": "USD",
      "included_services": [
        {
          "name": "Specialized Shuttle",
          "type": "transport",
          "amount": "1",
          "subtype": "specialized",
          "is_required": true,
          "sub_subtype": "specialized_shuttle",
          "is_requested": false,
          "amount_currency": "USD",
          "included_services": []
        },
        {
          "name": "Shadowbox",
          "type": "packing",
          "amount": "1",
          "subtype": "packing_materials",
          "is_required": true,
          "sub_subtype": "shadow_box",
          "is_requested": false,
          "amount_currency": "USD",
          "included_services": []
        }
      ],
      "optional_services": [
        {
          "name": "Debris Disposal",
          "type": "handling",
          "amount": "1",
          "subtype": "debris_disposal",
          "sub_subtype": "debris_disposal",
          "amount_currency": "USD",
          "included_services": [
            {
              "name": "Soft Packed Disposal",
              "type": "handling",
              "subtype": "debris_disposal",
              "sub_subtype": "soft_packed_disposal"
            }
          ]
        },
        {
          "name": "Assembly",
          "type": "handling",
          "amount": "1",
          "subtype": "installation",
          "sub_subtype": "assembly",
          "amount_currency": "USD",
          "included_services": []
        },
        {
          "name": "Placement",
          "type": "handling",
          "amount": "1",
          "subtype": "installation",
          "sub_subtype": "placement",
          "amount_currency": "USD",
          "included_services": []
        },
        {
          "name": "Installation",
          "type": "handling",
          "amount": "1",
          "subtype": "installation",
          "sub_subtype": "installation",
          "amount_currency": "USD",
          "included_services": []
        },
        {
          "name": "Condition Check (destination)",
          "type": "handling",
          "amount": "1",
          "subtype": "condition",
          "sub_subtype": "destination_condition_check",
          "amount_currency": "USD",
          "included_services": []
        },
        {
          "name": "Condition Check (origin)",
          "type": "handling",
          "amount": "1",
          "subtype": "condition",
          "sub_subtype": "origin_condition_check",
          "amount_currency": "USD",
          "included_services": []
        },
        {
          "name": "Condition Report (destination)",
          "type": "handling",
          "amount": "1",
          "subtype": "condition",
          "sub_subtype": "destination_full_condition_report",
          "amount_currency": "USD",
          "included_services": []
        },
        {
          "name": "Condition Report (origin)",
          "type": "handling",
          "amount": "1",
          "subtype": "condition",
          "sub_subtype": "origin_full_condition_report",
          "amount_currency": "USD",
          "included_services": []
        },
        {
          "name": "Unpacking (destination)",
          "type": "handling",
          "amount": "1",
          "subtype": "unpacking",
          "sub_subtype": "destination_unpacking",
          "amount_currency": "USD",
          "included_services": [
            {
              "name": "Unpacking Soft Materials (destination)",
              "type": "handling",
              "subtype": "unpacking",
              "sub_subtype": "destination_unpacking_soft"
            }
          ]
        }
      ],
      "included_insurance_policy": null
    },
    {
      "id": 62,
      "total": "4",
      "status": "published",
      "quote_type": "select",
      "total_currency": "USD",
      "included_services": [
        {
          "name": "Debris Disposal",
          "type": "handling",
          "amount": "1",
          "subtype": "debris_disposal",
          "is_required": true,
          "sub_subtype": "debris_disposal",
          "is_requested": false,
          "amount_currency": "USD",
          "included_services": [
            {
              "name": "Soft Packed Disposal",
              "type": "handling",
              "subtype": "debris_disposal",
              "sub_subtype": "soft_packed_disposal"
            }
          ]
        },
        {
          "name": "Fuel Surcharge",
          "type": "taxes_duties_fees",
          "amount": "1",
          "subtype": "fees",
          "is_required": true,
          "sub_subtype": "fuel_surcharge",
          "is_requested": false,
          "amount_currency": "USD",
          "included_services": []
        },
        {
          "name": "Strongbox",
          "type": "packing",
          "amount": "1",
          "subtype": "packing_materials",
          "is_required": true,
          "sub_subtype": "strongbox",
          "is_requested": false,
          "amount_currency": "USD",
          "included_services": []
        },
        {
          "name": "Consolidated Trucking",
          "type": "transport",
          "amount": "1",
          "subtype": "consolidated",
          "is_required": true,
          "sub_subtype": "road_groupage",
          "is_requested": false,
          "amount_currency": "USD",
          "included_services": []
        }
      ],
      "optional_services": [
        {
          "name": "Unpacking (destination)",
          "type": "handling",
          "amount": "1",
          "subtype": "unpacking",
          "sub_subtype": "destination_unpacking",
          "amount_currency": "USD",
          "included_services": [
            {
              "name": "Unpacking Soft Materials (destination)",
              "type": "handling",
              "subtype": "unpacking",
              "sub_subtype": "destination_unpacking_soft"
            }
          ]
        },
        {
          "name": "Condition Check (destination)",
          "type": "handling",
          "amount": "1",
          "subtype": "condition",
          "sub_subtype": "destination_condition_check",
          "amount_currency": "USD",
          "included_services": []
        },
        {
          "name": "Condition Check (origin)",
          "type": "handling",
          "amount": "1",
          "subtype": "condition",
          "sub_subtype": "origin_condition_check",
          "amount_currency": "USD",
          "included_services": []
        }
      ],
      "included_insurance_policy": null
    },
    {
      "id": 63,
      "total": "4",
      "status": "published",
      "quote_type": "parcel",
      "total_currency": "USD",
      "included_services": [
        {
          "name": "Fuel Surcharge",
          "type": "taxes_duties_fees",
          "amount": "1",
          "subtype": "fees",
          "is_required": true,
          "sub_subtype": "fuel_surcharge",
          "is_requested": false,
          "amount_currency": "USD",
          "included_services": []
        },
        {
          "name": "Collection",
          "type": "location",
          "amount": "1",
          "subtype": "collection",
          "is_required": true,
          "sub_subtype": "collection",
          "is_requested": false,
          "amount_currency": "USD",
          "included_services": []
        },
        {
          "name": "Ply Box",
          "type": "packing",
          "amount": "1",
          "subtype": "packing_materials",
          "is_required": true,
          "sub_subtype": "ply_box",
          "is_requested": false,
          "amount_currency": "USD",
          "included_services": []
        },
        {
          "name": "UPS Ground",
          "type": "transport",
          "amount": "1",
          "subtype": "parcel",
          "is_required": true,
          "sub_subtype": "parcel",
          "is_requested": false,
          "amount_currency": "USD",
          "included_services": []
        }
      ],
      "optional_services": [],
      "included_insurance_policy": null
    },
    {
      "id": 64,
      "total": "4",
      "status": "published",
      "quote_type": "parcel",
      "total_currency": "USD",
      "included_services": [
        {
          "name": "Fuel Surcharge",
          "type": "taxes_duties_fees",
          "amount": "1",
          "subtype": "fees",
          "is_required": true,
          "sub_subtype": "fuel_surcharge",
          "is_requested": false,
          "amount_currency": "USD",
          "included_services": []
        },
        {
          "name": "Collection",
          "type": "location",
          "amount": "1",
          "subtype": "collection",
          "is_required": true,
          "sub_subtype": "collection",
          "is_requested": false,
          "amount_currency": "USD",
          "included_services": []
        },
        {
          "name": "Ply Box",
          "type": "packing",
          "amount": "1",
          "subtype": "packing_materials",
          "is_required": true,
          "sub_subtype": "ply_box",
          "is_requested": false,
          "amount_currency": "USD",
          "included_services": []
        },
        {
          "name": "UPS Second Day Air",
          "type": "transport",
          "amount": "1",
          "subtype": "parcel",
          "is_required": true,
          "sub_subtype": "parcel",
          "is_requested": false,
          "amount_currency": "USD",
          "included_services": []
        }
      ],
      "optional_services": [],
      "included_insurance_policy": null
    },
    {
      "id": 65,
      "total": "4",
      "status": "published",
      "quote_type": "parcel",
      "total_currency": "USD",
      "included_services": [
        {
          "name": "Fuel Surcharge",
          "type": "taxes_duties_fees",
          "amount": "1",
          "subtype": "fees",
          "is_required": true,
          "sub_subtype": "fuel_surcharge",
          "is_requested": false,
          "amount_currency": "USD",
          "included_services": []
        },
        {
          "name": "Collection",
          "type": "location",
          "amount": "1",
          "subtype": "collection",
          "is_required": true,
          "sub_subtype": "collection",
          "is_requested": false,
          "amount_currency": "USD",
          "included_services": []
        },
        {
          "name": "Ply Box",
          "type": "packing",
          "amount": "1",
          "subtype": "packing_materials",
          "is_required": true,
          "sub_subtype": "ply_box",
          "is_requested": false,
          "amount_currency": "USD",
          "included_services": []
        },
        {
          "name": "UPS Next Day Air",
          "type": "transport",
          "amount": "1",
          "subtype": "parcel",
          "is_required": true,
          "sub_subtype": "parcel",
          "is_requested": false,
          "amount_currency": "USD",
          "included_services": []
        }
      ],
      "optional_services": [],
      "included_insurance_policy": null
    }
  ],
  "status": "quoted",
  "objects": [
    {
      "id": 1644,
      "type": "art",
      "depth": "2",
      "value": "15000",
      "width": "10",
      "height": "10.5",
      "images": [],
      "weight": "3.5",
      "details": {
        "title": "All That Jazz",
        "creator": "Robert Irwin",
        "is_cites": false,
        "materials": [],
        "is_fragile": false,
        "creation_date": null
      },
      "subtype": "painting_unframed",
      "weight_unit": "lb",
      "value_currency": "USD",
      "current_packing": [],
      "public_reference": null,
      "internal_reference": null,
      "unit_of_measurement": "in"
    }
  ],
  "bookable": {
    "ready": true,
    "missing": []
  },
  "currency": "USD",
  "insurance": null,
  "shortcode": "DEMO-R29NAW",
  "created_at": "2021-01-21T17:22:08.818747",
  "updated_at": "2021-01-21T17:22:10.129653",
  "destination": {
    "city": "New York",
    "title": "Home",
    "region": "NY",
    "country": "US",
    "contacts": [
      {
        "name": "Alfred Barr",
        "phone_number": "(222) 222-2222",
        "email_address": "al@example.com"
      }
    ],
    "postal_code": "11249",
    "address_line_1": "87 Richardson St",
    "address_line_2": null,
    "address_line_3": null,
    "access_restrictions": []
  },
  "quote_types": [
    "premium",
    "select",
    "parcel"
  ],
  "object_count": 1,
  "log_request_id": "FpL53jSpPbCUXRAAKPRS",
  "shipping_notes": null,
  "payment_process": "invoicing",
  "public_reference": null,
  "disqualifications": [],
  "hosted_session_id": 723,
  "internal_reference": null,
  "additional_services": [],
  "preferred_quote_types": []
}
Response examples (404)
# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "errors": {
    "detail": "string"
  }
}