The ARTA API integrates in to your digital platform so your customers and operations teams can instantly calculate shipping and handling costs for their purchases.

The API uses information about the objects you’re shipping and where those objects are going to automate packing recommendations and generate bookable quotes. Quotes typically include logistics options ranging from parcel transport to premium shipping services such as crating, customs, insurance, installation, and more.

These guides provide easy-to-follow walkthroughs for the API's key concepts. For detailed specifications of the API's endpoints, inputs, and outputs, view the API Reference documents.

The ARTA API follows RESTful conventions. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, and uses standard HTTP response codes, authentication, and verbs.

Key terms and resources

In the guides that follow we'll cover concepts and resources that describe the use and utility of ARTA's API. Before we jump in, lets define some of these terms specifically.

  • Organization — an Organization represents your company in ARTA's systems; this is the parent resource that owns all data and shipments generated by the API
  • API Key — an API key represents a secret token enabling your software services to make secure and authenticated calls into ARTA's API; your organization may have multiple API keys; each key works exclusively in either Live or Test modes
  • Quote Request — a quote request (aka a request) describes all of the guaranteed and bookable quotes for a given set of objects being shipped between two locations; generally you will make a quote request and then book a single quote from that request to create a shipment
  • Shipment — each shipment represents a booked transport for one or more objects between two locations
  • Log — a Log entry is one record in a running feed that describes all API calls issued by any of the API keys associated with your account; you can retrieve details about previous calls via the API for easy debugging and monitoring of your integration; each log describes key attributes about the API call including HTTP method, path, time, duration, and responses
  • Webhook — Webhooks describe API endpoints you can configure to receive programatic updates about changes to your shipments; implementing a webhook endpoint is useful if your company aims to build a custom notification system to inform your customers about shipment schedule/status changes and deliveries
  • Email Notification — ARTA's API can optionally deliver notifications about key changes in shipment status over email to your team and/or to your customers