Headers

• Authorization string Required

  Authorize your API calls with an Arta API token

Responses

• 201 application/json

  The created Import Cost Estimate

  Hide headers attributes Show headers attributes

  • content-type string
  • x-arta-request-id string

    A unique identifier for the Arta API call

  Hide response attributes Show response attributes object

  • 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.

  • destination object

    Details about the destination where it will be imported to

    Hide destination attributes Show destination attributes object

    • city string | null
    • country string

      ISO 3166-1 alpha-2 country code of the destination

    • postal_code string | null
    • region string | null

      State, province, or region of the destination.

  • end_use string | null

    The end use of the goods

    Values are for_resale or not_for_resale.

  • estimate object

    Breakdown of the estimated import costs

    Hide estimate attributes Show estimate attributes object

    • line_items array[object]

      Detailed breakdown of individual charges

      Hide line_items attributes Show line_items attributes object

      • amount string

        Amount of the charge in the estimate currency

      • description string

        Description of the charge

      • subtype string

        Subtype classification of the charge

      • type string

        Type of charge (e.g., duty, tax, fee)

    • summary object

      Summary totals of the import cost estimate

      Hide summary attributes Show summary attributes object

      • duties string

        Total duties amount

      • fees string

        Total fees amount

      • taxes string

        Total taxes amount

  • id string(uuid)

    Unique identifier for the import cost estimate

  • objects array[object]

    List of objects/items being imported

    Hide objects attributes Show objects attributes object

    • country_of_origin string | null

      ISO 3166-1 alpha-2 country code where the object originated

    • hs_code string

      Harmonized System (HS) tariff code for the object

    • quantity number | null

      Quantity of the object

    • reference string | null

      Reference identifier for the object

    • value string

      Declared value of the object

    • value_currency string | null

      Currency code (ISO 4217) used for the object's declared value

  • origin object

    Details about the origin location

    Hide origin attribute Show origin attribute object

    • country string

      ISO 3166-1 alpha-2 country code of the origin

  • reference string | null

    Reference string for identifying the estimate in your systems

  • shortcode string

    Short automatically generated reference code for the identifying import cost estimate in Arta's system

  • status string

    Status of the import cost estimate calculation

    Values are failed or success.

  • transport object

    Information about the transport method and cost

    Hide transport attributes Show transport attributes object

    • amount string

      Total transport cost

    • amount_currency string | null

      Currency code (ISO 4217) for the transport amount

    • service_level string

      Service level for transport (e.g., ups_expedited, fedex_international_first etc). Options are listed in the reference rate service levels metadata endpoint

• 400 application/json

  Bad Request

  Hide headers attributes Show headers attributes

  • content-type string
  • x-arta-request-id string

    A unique identifier for the Arta API call

  Hide response attribute Show response attribute object

  • errors object
    Hide errors attribute Show errors attribute object

    • detail string