Getting started
Developers dashboard
To manage your integration, you will need to be an Owner of an Organization within the Arta Dashboard.
When an Organization is first created it can take 1-2 business days for Arta to enable the Developers tab on the left navigation bar.
Once available, you will be able to create Test mode API keys to begin building your integration. While in Test mode the Dashboard will have a gold banner at the bottom of the screen.
Test mode hits the same endpoints as Live mode, the one difference is that all service costs return as $1. Arta will enable Live mode ahead of launch.
Under Hosted Products are many of the other configurable features such as Email Rules and Branding.
Inventory intake
In order to make valid Requests for quotes, you must provide information about the objects you are shipping, as outlined in our API Reference. For fields that require specific types, refer to our Metadata endpoints.
At a minimum, Arta needs to know what type of object, the dimensions, and the value.
-
Dimensions are of the objects physically being shipped. For example, if the object is a framed work on paper this is the framed dimensions not the image dimensions.
-
If product contains multiple objects, such as a set of chairs, Arta needs to receive an object record with dimensions for each.
-
Arta’s Metadata lists are extensive, most clients map their own taxonomy or make a selection for their UIs. For items that are not represented, Arta includes ‘Other’ subtypes.
Note: If unrealistic dummy data is provided (including large object values or made up street addresses) our system can fail to return a quote.
For clients considering Self Ship
The Preferred Quote Types field can be used to specify if Self Ship quotes should be included on each Request.
For marketplaces, most clients ask the sellers to input if they can pack or not.
For retailers, you may opt to set this at the object level for inventory.
Important data fields
Object Type
- Arta has a set list of object types used for quoting
- Alcohol, automotives and firearms are not supported
Size (metric, imperial)
- Height and length are required for each object
- Weight is only required for large objects
- External shipping dimensions are required for every component of an object
Value (USD, CAD, GBP, EUR, HKD)
- Object values are used to calculate insurance
- Should represent the total invoiced to the buyer, including premiums and taxes
Packing Arta has a set list of current packing types supported Arta has packing requirements for each object and evaluates if current packing is sufficient while quoting
Details Objects can be specifically listed as fragile and Arta will parse the object description for fragile keywords Titles and images are included on manifests and BOLs
Client References Public reference field for buyers reference Internal reference field for record keeping
Data required to book a shipment
To Quote
| Address | Object |
|---|---|
| Postcode | Type |
| Country | Height X Width |
| Value |
To Book
| Address | Object |
|---|---|
| Street Address | Type |
| City | Height X Width |
| Postcode | Value |
| Country | |
| Contact Information |
Highly recommended: Depth, Weight, Shipment Public Reference, Object Public Reference, Insurance opted in or out.
Quote Display
Arta will return all available quotes for every Request.
Most clients design a UI that transforms those responses to meet their customer’s expectations. Some options with Arta are:
- Showing the lowest shipping cost only and automatically including it in their cart
- Providing a choice of each quote type
- Rebranding services with different names and descriptions
- Subsidizing or adding margin to shipping costs
- Offering Transit Insurance as an optional service
There will be times when no quote is returned and the Request status is ‘Disqualified’. You will need to account for this edge case for a successful implementation. This typically occurs when items are greater than $1 million, over 25 cuft, delivering to sanctioned countries.
For custom pricing for these unique shipments, you can request a custom quote.
Booking
Enables customers to input or edit the destination address, generating requests to different locations.
Data input into Create New Booking Session form on the dashboard or provided via spreadsheet for Arta.
Request
A single combination of origin and destination information and the quotes available.
- Requests can be generated with only a post-code and country.
- Requests are non-committal and customers can try multiple addresses.
- When a customer is ready to proceed, they will need to provide complete data.
Shipment
The selected quote will alert Arta of a physical movement that needs to occur.
Once a Shipment is booked, Arta will automatically take action towards delivery.
Fulfillment
To proceed with fulfillment, Create a Shipment.
The Request will have a status of Closed and a new Shipment record will be created. The Shipment will have a status of Pending until it is scheduled with a carrier.
Billing
If your Organization is Prepaid and customers will be paying Arta directly on our hosted Checkout UI, you will see a Prepayment Required Exception. If your Organization is on Terms, and you will be collecting payment for the shipping costs, there will be no Exception and Arta will email an invoice once the Shipment’s status is ‘In Transit’.
If you do not feel your account billing is configured correctly, please contact Arta.
Once a Shipment is booked
A Tracking URL will be available. This Tracking page will automatically update as the Shipment progresses to delivery.
Customer-facing Email Rules can be configured in the Dashboard. To power your own emails or order pages you can create Webhook Endpoints.
Arta notifications include Exceptions if a delay or hold occurs, including address changes, customs clearance and not being able to deliver.
For Self Ship, shipping label URLs are also included on the Shipment record and are available shortly after booking for US domestic shipments.