ARTA Public API

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.

This is the documentation for version 2021-01-01 of the API. Last update on Apr 12, 2021.

Base URL
https://api.shiparta.com

API structure has changed on
  • Updated: GET /metadata/currencies
  • Response modified: 200
  • Body attribute added: symbol
  • Body attributes removed: description, has_decimal
API structure has changed on
  • Updated: GET /invoice_payments
  • Response modified: 200
  • Updated: GET /invoices
  • Response modified: 200
  • Updated: GET /invoices/{invoice_id}
  • Response modified: 200
  • Body attribute added: invoice_url
  • Body attributes removed: external_id, external_invoice_url, external_system
  • Updated: GET /payments
  • Response modified: 200
  • Updated: GET /payments/{payment_id}
  • Response modified: 200
  • Body attribute added: context
  • Body attribute removed: external_id
  • Removed: PATCH /requests/{request_id}/custom
  • Removed: PATCH /requests/{request_id}/cancel
API structure has changed on
  • Added: GET /invoice_payments
  • Added: GET /invoice_payments/{invoice_payment_id}
  • Added: GET /invoices
  • Added: GET /invoices/{invoice_id}
  • Added: GET /payments
  • Added: GET /payments/{payment_id}
API structure has changed on
  • Updated: POST /requests
  • Response modified: 201
  • Updated: GET /requests/{request_id}
  • Response modified: 200
  • Updated: PATCH /requests/{request_id}/custom
  • Response modified: 200
  • Updated: PATCH /requests/{request_id}/cancel
  • Response modified: 200
API structure has changed on
  • Updated: POST /requests
  • Response modified: 201
  • Updated: GET /requests/{request_id}
  • Response modified: 200
  • Updated: PATCH /requests/{request_id}/custom
  • Response modified: 200
  • Updated: PATCH /requests/{request_id}/cancel
  • Response modified: 200
  • Updated: POST /shipments
  • Response modified: 200
  • Updated: GET /shipments/{shipment_id}
  • Response modified: 200
API structure has changed on
  • Added: GET /metadata/location_access_restrictions
  • Added: GET /metadata/object_materials
  • Updated: POST /requests
  • Response modified: 201
  • Updated: GET /requests/{request_id}
  • Response modified: 200
  • Updated: PATCH /requests/{request_id}/custom
  • Response modified: 200
  • Updated: PATCH /requests/{request_id}/cancel
  • Response modified: 200
API structure has changed on
  • Updated: POST /requests
  • Response modified: 201
  • Updated: GET /requests/{request_id}
  • Response modified: 200
  • Updated: PATCH /requests/{request_id}/custom
  • Response modified: 200
  • Updated: PATCH /requests/{request_id}/cancel
  • Response modified: 200
API structure has changed on
  • Added: GET /requests
  • Updated: POST /requests
  • Body attribute added: request
  • Body attributes removed: additional_services, currency_code, customer_reference, insurance, name, notes, objects, origin_locations, destination_locations
  • Response modified: 201
  • Body attributes added: bookable, currency, destination, disqualifications, internal_reference, object_count, origin, public_reference, quote_types, quotes, shipping_notes
  • Body attributes removed: currency_code, customer_reference, name, notes, origin_locations, request_type
  • Updated: GET /requests/{request_id}
  • Response modified: 200
  • Body attributes added: bookable, currency, destination, disqualifications, internal_reference, object_count, origin, public_reference, quote_types, quotes, shipping_notes
  • Body attributes removed: currency_code, customer_reference, name, notes, origin_locations, request_type
  • Removed: DELETE /requests/{request_id}
  • Updated: PATCH /requests/{request_id}/custom
  • Response added: 200
  • Response removed: 202
  • Removed: POST /requests/{request_id}/book/{quote_id}
  • Added: PATCH /requests/{request_id}/cancel
  • Updated: GET /shipments
  • Response modified: 200
  • Body attribute modified: items
  • Added: POST /shipments
  • Updated: GET /shipments/{shipment_id}
  • Response modified: 200
  • Body attributes added: destination, insurance_policy, internal_reference, object_count, origin, public_reference, quote_type, schedule, services, shipping_notes, shortcode, tracking
  • Body attributes removed: packing, insurance, quote, name
API structure has changed on
  • Added: GET /metadata/request_statuses
  • Added: GET /metadata/shipment_statuses
API structure has changed on
  • Added: GET /metadata/packings
  • Added: GET /metadata/quotes
  • Added: GET /metadata/services
API structure has changed on
  • Added: GET /metadata/insurances
  • Added: GET /metadata/objects
API structure has changed on
  • Added: GET /metadata/api_versions
  • Added: GET /metadata/email_notifications
API structure has changed on
  • Added: GET /metadata/currencies
API structure has changed on
  • Updated: POST /requests/{request_id}/book/{quote_id}
  • Body attributes added: customer_reference, location_details
  • Body attribute removed: api_key
API structure has changed on
  • Updated: GET /shipments
  • Response modified: 200
  • Updated: GET /shipments/{shipment_id}
  • Response modified: 200
  • Body attributes added: status, packing, insurance, packages
API structure has changed on
  • Updated: GET /api_keys
  • Response modified: 200
  • Updated: POST /api_keys
  • Response modified: 201
  • Body attribute added: created_at
  • Body attribute removed: inserted_at
  • Updated: GET /api_keys/{api_key_id}
  • Response modified: 200
  • Body attribute added: created_at
  • Body attribute removed: inserted_at
  • Updated: GET /email_rules
  • Response modified: 200
  • Updated: POST /email_rules
  • Response modified: 201
  • Body attribute added: created_at
  • Body attribute removed: inserted_at
  • Updated: GET /email_rules/{email_rule_id}
  • Response modified: 200
  • Body attribute added: created_at
  • Body attribute removed: inserted_at
  • Updated: PATCH /email_rules/{email_rule_id}
  • Response modified: 200
  • Body attribute added: created_at
  • Body attribute removed: inserted_at
  • Updated: GET /email_subscriptions
  • Response modified: 200
  • Updated: POST /email_subscriptions
  • Response modified: 201
  • Body attribute added: created_at
  • Body attribute removed: inserted_at
  • Updated: GET /email_subscriptions/{email_subscription_id}
  • Response modified: 200
  • Body attribute added: created_at
  • Body attribute removed: inserted_at
  • Updated: PATCH /email_subscriptions/{email_subscription_id}
  • Response modified: 200
  • Body attribute added: created_at
  • Body attribute removed: inserted_at
  • Updated: GET /logs
  • Response modified: 200
  • Updated: GET /logs/{log_id}
  • Response modified: 200
  • Body attribute added: created_at
  • Body attribute removed: inserted_at
  • Updated: GET /organization
  • Response modified: 200
  • Body attribute added: created_at
  • Body attribute removed: inserted_at
  • Updated: PATCH /organization
  • Response modified: 200
  • Body attribute added: created_at
  • Body attribute removed: inserted_at
  • Updated: POST /requests
  • Updated: POST /requests/{request_id}/book/{quote_id}
  • Updated: GET /shipments
  • Response modified: 200
  • Updated: GET /shipments/{shipment_id}
  • Response modified: 200
  • Body attributes added: url, name, total, total_currency, quote
  • Updated: GET /webhooks
  • Response modified: 200
  • Updated: POST /webhooks
  • Response modified: 201
  • Body attribute added: created_at
  • Body attribute removed: inserted_at
  • Updated: GET /webhooks/{webhook_id}
  • Response modified: 200
  • Body attribute added: created_at
  • Body attribute removed: inserted_at
  • Updated: PATCH /webhooks/{webhook_id}
  • Response modified: 200
  • Body attribute added: created_at
  • Body attribute removed: inserted_at
  • Updated: POST /webhooks/{webhook_id}/ping
  • Response modified: 200
  • Body attribute added: created_at
  • Body attribute removed: inserted_at
API structure has changed on
  • Updated: POST /requests
  • Body attribute added: destination_locations
  • Body attributes modified: additional_services, currency_code, customer_reference, insurance, name, notes
API structure has changed on
  • Updated: POST /requests
  • Body attributes removed: request_type, status
API structure has changed on
  • Updated: POST /requests
  • Body attributes added: additional_services, currency_code, customer_reference, insurance, name, notes, objects, origin_locations, request_type, status
  • Body attribute removed: api_key
API structure has changed on
  • Updated: POST /requests
  • Response modified: 201
  • Body attributes added: additional_services, currency_code, customer_reference, insurance, name, notes, objects, origin_locations, request_type, status
  • Updated: GET /requests/{request_id}
  • Response modified: 200
  • Body attributes added: additional_services, currency_code, customer_reference, insurance, name, notes, objects, origin_locations, request_type, status
  • Updated: POST /requests/{request_id}/book/{quote_id}
  • Response modified: 200
  • Body attributes added: additional_services, currency_code, customer_reference, insurance, name, notes, objects, origin_locations, request_type, status
API documentation has been created on