Authorize your API calls with an ARTA API token
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 Feb 19, 2021.
Base URL
https://api.shiparta.comThe ARTA API accepts server-to-server communications authenticated by API keys. Your API keys are self-managed and unique to your organization.
Using your API key to authenticate an API call is straightforward. Simply include your API Key token in the Authorization header of every call made to the system. This is the only place that it is accepted.
$ curl \
-X GET https://api.shiparta.com/shipments \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Headers
-
Authorization Required / string
URL parameters
-
page_size integer
Results per page (max 50)
-
page integer
Page number of the results to fetch.
Responses
-
• 200 object
A succesful collection of API Keys associated with your organization
-
content-type string
-
x-arta-request-id string
-
items array[object]
-
items.id integer(int64)
-
items.created_at string
-
items.is_testing boolean
-
items.token string
-
items.updated_at string
-
-
metadata object
-
metadata.page integer(int64)
-
metadata.page_size integer(int64)
-
metadata.total_count integer(int64)
-
-
Definition
GET https://api.shiparta.com/api_keyscURL example
curl \
-X GET https://api.shiparta.com/api_keys \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"items": [
{
"id": 42,
"created_at": "2020-10-15T19:50:02.914779",
"is_testing": true,
"token": "******************eQ0Rqp",
"updated_at": "2020-10-15T19:50:02.914779"
},
{
"id": 41,
"created_at": "2020-08-07T03:49:45.000000",
"is_testing": false,
"token": "******************VBiYj6",
"updated_at": "2020-08-07T03:49:45.000000"
}
],
"metadata": {
"page": 1,
"page_size": 20,
"total_count": 2
}
}Create an API Key
You can create mulitple API keys for your organization. All API keys operate on either Live or Test modes.
Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
Body
-
api_key object
-
api_key.is_testing boolean
Whether this API Key should operate in Live or Test mode.
-
Responses
-
• 201 object
response
-
content-type string
-
x-arta-request-id string
-
id integer(int64)
-
created_at string
-
is_testing boolean
-
token string
-
updated_at string
-
-
• 400 object
Bad Request
-
errors object
-
errors.detail string
-
-
Definition
POST https://api.shiparta.com/api_keyscURL example
curl \
-X POST https://api.shiparta.com/api_keys \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
-d '{"api_key":{"is_testing":true}}'Request payload example
# Headers
Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y
# Payload
{
"api_key": {
"is_testing": true
}
}Response example (201)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"id": 42,
"created_at": "2020-10-15T19:50:02.914779",
"is_testing": true,
"token": "a8dG3tcspo9dinqePjcQ0Rqp",
"updated_at": "2020-10-15T19:50:02.914779"
}Response example (400)
{
"errors": {
"detail": "string"
}
}Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
api_key_id Required / integer
api_key_id parameter
Responses
-
• 200 object
Successful API Key response
-
content-type string
-
x-arta-request-id string
-
id integer(int64)
-
created_at string
-
is_testing boolean
-
token string
-
updated_at string
-
-
• 404 object
Resource Not Found
-
content-type string
-
x-arta-request-id string
-
errors object
-
errors.detail string
-
-
Definition
GET https://api.shiparta.com/api_keys/{api_key_id}cURL example
curl \
-X GET https://api.shiparta.com/api_keys/{api_key_id} \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"id": 42,
"created_at": "2020-10-15T19:50:02.914779",
"is_testing": true,
"token": "a8dG3tcspo9dinqePjcQ0Rqp",
"updated_at": "2020-10-15T19:50:02.914779"
}Response example (404)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"errors": {
"detail": "string"
}
}Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
api_key_id Required / integer
api_key_id parameter
Responses
-
• 204
An empty response from the ARTA API
-
content-type string
-
x-arta-request-id string
-
-
• 404 object
Resource Not Found
-
content-type string
-
x-arta-request-id string
-
errors object
-
errors.detail string
-
-
Definition
DELETE https://api.shiparta.com/api_keys/{api_key_id}cURL example
curl \
-X DELETE https://api.shiparta.com/api_keys/{api_key_id} \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (204)
# Headers
content-type: string
x-arta-request-id: stringResponse example (404)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"errors": {
"detail": "string"
}
}Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
page_size integer
Results per page (max 50)
-
page integer
Page number of the results to fetch.
Responses
-
• 200 object
A collection of Email Rules
-
content-type string
-
x-arta-request-id string
-
items array[object]
-
items.email_notification_id string
-
items.id integer(int64)
-
items.created_at string
-
items.recipients array[string]
-
items.updated_at string
-
-
metadata object
-
metadata.page integer(int64)
-
metadata.page_size integer(int64)
-
metadata.total_count integer(int64)
-
-
Definition
GET https://api.shiparta.com/email_rulescURL example
curl \
-X GET https://api.shiparta.com/email_rules \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"items": [
{
"email_notification_id": "complete",
"id": 7,
"created_at": "2020-10-14T15:29:06.263371",
"recipients": [
"destination"
],
"updated_at": "2020-10-14T15:29:06.263371"
}
],
"metadata": {
"page": 1,
"page_size": 20,
"total_count": 1
}
}Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
Body
-
email_rule object
-
email_rule.email_notification_id Required / string
The ID belonging to the Email Notification for this Email Rule.
-
email_rule.recipients Required / array[string]
The list of recipients for this Email Rule.
-
Responses
-
• 201 object
response
-
content-type string
-
x-arta-request-id string
-
email_notification_id string
-
id integer(int64)
-
created_at string
-
recipients array[string]
-
updated_at string
-
-
• 400 object
Bad Request
-
errors object
-
errors.detail string
-
-
Definition
POST https://api.shiparta.com/email_rulescURL example
curl \
-X POST https://api.shiparta.com/email_rules \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
-d '{"email_rule":{"email_notification_id":"booking","recipients":["string"]}}'Request payload example
# Headers
Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y
# Payload
{
"email_rule": {
"email_notification_id": "booking",
"recipients": [
"string"
]
}
}Response example (201)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"email_notification_id": "complete",
"id": 7,
"created_at": "2020-10-14T15:29:06.263371",
"recipients": [
"destination"
],
"updated_at": "2020-10-14T15:29:06.263371"
}Response example (400)
{
"errors": {
"detail": "string"
}
}Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
email_rule_id Required / integer
email_rule_id parameter
Responses
-
• 200 object
Successful Email Rule response
-
content-type string
-
x-arta-request-id string
-
email_notification_id string
-
id integer(int64)
-
created_at string
-
recipients array[string]
-
updated_at string
-
-
• 404 object
Resource Not Found
-
content-type string
-
x-arta-request-id string
-
errors object
-
errors.detail string
-
-
Definition
GET https://api.shiparta.com/email_rules/{email_rule_id}cURL example
curl \
-X GET https://api.shiparta.com/email_rules/{email_rule_id} \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"email_notification_id": "complete",
"id": 7,
"created_at": "2020-10-14T15:29:06.263371",
"recipients": [
"destination"
],
"updated_at": "2020-10-14T15:29:06.263371"
}Response example (404)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"errors": {
"detail": "string"
}
}Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
email_rule_id Required / integer
email_rule_id parameter
Responses
-
• 204
An empty response from the ARTA API
-
content-type string
-
x-arta-request-id string
-
-
• 404 object
Resource Not Found
-
content-type string
-
x-arta-request-id string
-
errors object
-
errors.detail string
-
-
Definition
DELETE https://api.shiparta.com/email_rules/{email_rule_id}cURL example
curl \
-X DELETE https://api.shiparta.com/email_rules/{email_rule_id} \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (204)
# Headers
content-type: string
x-arta-request-id: stringResponse example (404)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"errors": {
"detail": "string"
}
}Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
email_rule_id Required / integer
email_rule_id parameter
Body
-
email_rule object
-
email_rule.recipients Required / array[string]
The list of recipients for this Email Rule.
-
Responses
-
• 200 object
Successful Email Rule response
-
content-type string
-
x-arta-request-id string
-
email_notification_id string
-
id integer(int64)
-
created_at string
-
recipients array[string]
-
updated_at string
-
-
• 404 object
Resource Not Found
-
content-type string
-
x-arta-request-id string
-
errors object
-
errors.detail string
-
-
Definition
PATCH https://api.shiparta.com/email_rules/{email_rule_id}cURL example
curl \
-X PATCH https://api.shiparta.com/email_rules/{email_rule_id} \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
-d '{"email_rule":{"recipients":["string"]}}'Request payload example
# Headers
Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y
# Payload
{
"email_rule": {
"recipients": [
"string"
]
}
}Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"email_notification_id": "complete",
"id": 7,
"created_at": "2020-10-14T15:29:06.263371",
"recipients": [
"destination"
],
"updated_at": "2020-10-14T15:29:06.263371"
}Response example (404)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"errors": {
"detail": "string"
}
}List Email Subscriptions
Retrieve a paginated collection of Email Subscriptions belonging to your Organization
Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
page_size integer
Results per page (max 50)
-
page integer
Page number of the results to fetch.
Responses
-
• 200 object
A collection of Email Subscriptions
-
content-type string
-
x-arta-request-id string
-
items array[object]
-
items.email_address string
-
items.email_notification_ids array[string]
-
items.id integer(int64)
-
items.created_at string
-
items.name string
-
items.updated_at string
-
-
metadata object
-
metadata.page integer(int64)
-
metadata.page_size integer(int64)
-
metadata.total_count integer(int64)
-
-
Definition
GET https://api.shiparta.com/email_subscriptionscURL example
curl \
-X GET https://api.shiparta.com/email_subscriptions \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"items": [
{
"email_address": "notifications@shiparta.com",
"email_notification_ids": [
"booking",
"complete",
"scheduling"
],
"id": 6,
"created_at": "2020-10-14T15:25:48.298369",
"name": "ARTA Notifications",
"updated_at": "2020-10-14T15:25:48.298369"
}
],
"metadata": {
"page": 1,
"page_size": 20,
"total_count": 1
}
}Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
Body
-
email_subscription object
-
email_subscription.email_address string
The email_address for this Email Subscription.
-
email_subscription.email_notification_ids array[string]
The list of Email Notification IDs for this Email Subscription.
-
email_subscription.name string
The name for this Email Subscription. This name will be used in conjunction with the email address field to build the recipient when delivering email notifications.
-
Responses
-
• 201 object
response
-
content-type string
-
x-arta-request-id string
-
email_address string
-
email_notification_ids array[string]
-
id integer(int64)
-
created_at string
-
name string
-
updated_at string
-
-
• 400 object
Bad Request
-
errors object
-
errors.detail string
-
-
Definition
POST https://api.shiparta.com/email_subscriptionscURL example
curl \
-X POST https://api.shiparta.com/email_subscriptions \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
-d '{"email_subscription":{"email_address":"hello@shiparta.com","email_notification_ids":["string"],"name":"Arta"}}'Request payload example
# Headers
Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y
# Payload
{
"email_subscription": {
"email_address": "hello@shiparta.com",
"email_notification_ids": [
"string"
],
"name": "Arta"
}
}Response example (201)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"email_address": "notifications@shiparta.com",
"email_notification_ids": [
"booking",
"complete",
"scheduling"
],
"id": 6,
"created_at": "2020-10-14T15:25:48.298369",
"name": "ARTA Notifications",
"updated_at": "2020-10-14T15:25:48.298369"
}Response example (400)
{
"errors": {
"detail": "string"
}
}Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
email_subscription_id Required / integer
email_subscription_id parameter
Responses
-
• 200 object
Successful Email Subscription response
-
content-type string
-
x-arta-request-id string
-
email_address string
-
email_notification_ids array[string]
-
id integer(int64)
-
created_at string
-
name string
-
updated_at string
-
-
• 404 object
Resource Not Found
-
content-type string
-
x-arta-request-id string
-
errors object
-
errors.detail string
-
-
Definition
GET https://api.shiparta.com/email_subscriptions/{email_subscription_id}cURL example
curl \
-X GET https://api.shiparta.com/email_subscriptions/{email_subscription_id} \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"email_address": "notifications@shiparta.com",
"email_notification_ids": [
"booking",
"complete",
"scheduling"
],
"id": 6,
"created_at": "2020-10-14T15:25:48.298369",
"name": "ARTA Notifications",
"updated_at": "2020-10-14T15:25:48.298369"
}Response example (404)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"errors": {
"detail": "string"
}
}Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
email_subscription_id Required / integer
email_subscription_id parameter
Responses
-
• 204
An empty response from the ARTA API
-
content-type string
-
x-arta-request-id string
-
-
• 404 object
Resource Not Found
-
content-type string
-
x-arta-request-id string
-
errors object
-
errors.detail string
-
-
Definition
DELETE https://api.shiparta.com/email_subscriptions/{email_subscription_id}cURL example
curl \
-X DELETE https://api.shiparta.com/email_subscriptions/{email_subscription_id} \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (204)
# Headers
content-type: string
x-arta-request-id: stringResponse example (404)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"errors": {
"detail": "string"
}
}Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
email_subscription_id Required / integer
email_subscription_id parameter
Body
-
email_subscription object
-
email_subscription.recipients array[string]
The list of recipients for this Email Subscription.
-
Responses
-
• 200 object
Successful Email Subscription response
-
content-type string
-
x-arta-request-id string
-
email_address string
-
email_notification_ids array[string]
-
id integer(int64)
-
created_at string
-
name string
-
updated_at string
-
-
• 404 object
Resource Not Found
-
content-type string
-
x-arta-request-id string
-
errors object
-
errors.detail string
-
-
Definition
PATCH https://api.shiparta.com/email_subscriptions/{email_subscription_id}cURL example
curl \
-X PATCH https://api.shiparta.com/email_subscriptions/{email_subscription_id} \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
-d '{"email_subscription":{"recipients":["string"]}}'Request payload example
# Headers
Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y
# Payload
{
"email_subscription": {
"recipients": [
"string"
]
}
}Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"email_address": "notifications@shiparta.com",
"email_notification_ids": [
"booking",
"complete",
"scheduling"
],
"id": 6,
"created_at": "2020-10-14T15:25:48.298369",
"name": "ARTA Notifications",
"updated_at": "2020-10-14T15:25:48.298369"
}Response example (404)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"errors": {
"detail": "string"
}
}Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
page_size integer
Results per page (max 50)
-
page integer
Page number of the results to fetch.
Responses
-
• 200 object
A collection of Log records
-
content-type string
-
x-arta-request-id string
-
items array[object]
-
items.api_key_id integer(int64)
-
items.arta_version string
-
items.end_at string
-
items.id integer(int64)
-
items.created_at string
-
items.method string
-
items.path string
-
items.query_params string
-
items.request_body string
-
items.request_id string
-
items.response_body string
-
items.start_at string
-
items.status integer(int64)
-
items.updated_at string
-
-
metadata object
-
metadata.page integer(int64)
-
metadata.page_size integer(int64)
-
metadata.total_count integer(int64)
-
-
Definition
GET https://api.shiparta.com/logscURL example
curl \
-X GET https://api.shiparta.com/logs \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"items": [
{
"api_key_id": 1,
"arta_version": "2020-10-22",
"end_at": "2020-10-23T20:34:28.816433",
"id": 320,
"created_at": "2020-10-23T20:34:29.066599",
"method": "POST",
"path": "/requests",
"request_id": "FkC5WHWtbZuuUtcAArFx",
"start_at": "2020-10-23T20:34:16.928374",
"status": 200,
"updated_at": "2020-10-23T20:34:29.066599"
}
],
"metadata": {
"page": 1,
"page_size": 20,
"total_count": 1
}
}Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
log_id Required / integer
log_id parameter
Responses
-
• 200 object
Successful Log response
-
content-type string
-
x-arta-request-id string
-
api_key_id integer(int64)
-
arta_version string
-
end_at string
-
id integer(int64)
-
created_at string
-
method string
-
path string
-
query_params string
-
request_body string
-
request_id string
-
response_body string
-
start_at string
-
status integer(int64)
-
updated_at string
-
-
• 404 object
Resource Not Found
-
content-type string
-
x-arta-request-id string
-
errors object
-
errors.detail string
-
-
Definition
GET https://api.shiparta.com/logs/{log_id}cURL example
curl \
-X GET https://api.shiparta.com/logs/{log_id} \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"api_key_id": 1,
"arta_version": "2020-10-22",
"end_at": "2020-10-23T20:34:28.816433",
"id": 320,
"created_at": "2020-10-23T20:34:29.066599",
"method": "POST",
"path": "/requests",
"query_params": "{}",
"request_body": "",
"request_id": "FkC5WHWtbZuuUtcAArFx",
"response_body": "",
"start_at": "2020-10-23T20:34:16.928374",
"status": 200,
"updated_at": "2020-10-23T20:34:29.066599"
}Response example (404)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"errors": {
"detail": "string"
}
}API Versions
Retrieve the list of versions for ARTA's API.
A version may be passed along in API calls as an arta-version request header to target a specific API version.
Additionally, you may set a default API version on your Organization to fallback to a particular version.
Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
Responses
-
• 200 array[object]
A collection of API Versions
-
content-type string
-
x-arta-request-id string
-
description string
A long form description
-
authentication array[string]
The list of authentication schema supported by this API version
-
id string
The ID representing the resource
-
status string
Indicates whether the API version is active, beta, or deprecated
-
Definition
GET https://api.shiparta.com/metadata/api_versionscURL example
curl \
-X GET https://api.shiparta.com/metadata/api_versions \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
[
{
"description": "A key-authenticated API Version released on October 22, 2020.",
"authentication": [
"api_key"
],
"id": "2020-10-22",
"status": "active"
}
]Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
Responses
-
• 200 array[object]
A collection of currencies
-
content-type string
-
x-arta-request-id string
-
description string
A long form description of the currency
-
has_decimal boolean
Whether the currency supports numeric values with a decimal point
-
id string
The ID representing the resource
-
name string
A brief label for the currency
-
Definition
GET https://api.shiparta.com/metadata/currenciescURL example
curl \
-X GET https://api.shiparta.com/metadata/currencies \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
[
{
"description": "United States Dollar",
"has_decimal": true,
"id": "USD",
"name": "USD"
}
]Email Notifications
ARTA's email notifications are optional and configurable. You can use email rules and email subscriptions to dictate whether ARTA delivers them on your behalf to either internal or external recipients.
The Email Notifications metadata endpoint lists the current notification types and their properties.
Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
Responses
-
• 200 array[object]
A collection of Email Notifications
-
content-type string
-
x-arta-request-id string
-
description string
A long form description
-
optional_recipients array[string]
The list of configurable recipients for this notification
-
id string
The ID representing the resource
-
name string
A brief title for the resource
-
Definition
GET https://api.shiparta.com/metadata/email_notificationscURL example
curl \
-X GET https://api.shiparta.com/metadata/email_notifications \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
[
{
"description": "Delivered when a shipment is confirmed.",
"optional_recipients": [
"destination"
],
"id": "booking",
"name": "Booking Confirmation"
}
]Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
Responses
-
• 200 array[object]
A collection of Insurance types
-
content-type string
-
x-arta-request-id string
-
description string
A long form description
-
id string
The ID representing the resource
-
name string
A brief title for the resource
-
Definition
GET https://api.shiparta.com/metadata/insurancescURL example
curl \
-X GET https://api.shiparta.com/metadata/insurances \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
[
{
"description": "ARTA full risk coverage transit insurance.",
"id": "arta_transit_insurance",
"name": "ARTA Full Risk"
}
]Location Access Restrictions
Retrieve the list of valid Location Access Restriction objects for origin and destination locations.
The "Create a Quote Request" endpoint accepts a list of Location Access Restriction IDs for each location.
Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
Responses
-
• 200 array[object]
A collection of API Versions
-
content-type string
-
x-arta-request-id string
-
description string
A long form description
-
id string
The ID representing the resource
-
name string
A brief label for the resource
-
Definition
GET https://api.shiparta.com/metadata/location_access_restrictionscURL example
curl \
-X GET https://api.shiparta.com/metadata/location_access_restrictions \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
[
{
"description": "The location can only be accessed by elevator",
"id": "elevator_only",
"name": "Only Elevator"
}
]Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
Responses
-
• 200 array[object]
A collection of Insurance types
-
content-type string
-
x-arta-request-id string
-
description string
A long form description
-
id string
The ID representing the resource
-
name string
A brief title for the resource
-
subtypes array[object]
The subtypes for this resource
-
subtypes.description string
A long form description
-
subtypes.id string
The ID representing the resource
-
subtypes.name string
A brief title for the resource
-
-
Definition
GET https://api.shiparta.com/metadata/objectscURL example
curl \
-X GET https://api.shiparta.com/metadata/objects \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
[
{
"description": "Works of art various media including paintings, sculpture, or works on paper.",
"id": "art",
"name": "Works of art",
"subtypes": [
{
"description": "A painting that is framed behind a glass face.",
"id": "painting_framed_glass",
"name": "Painting (framed with glass)"
}
]
}
]Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
Responses
-
• 200 array[object]
A collection of object materials
-
content-type string
-
x-arta-request-id string
-
description string
A long form description of the currency
-
id string
The ID representing the resource
-
name string
A brief label for the resource
-
Definition
GET https://api.shiparta.com/metadata/object_materialscURL example
curl \
-X GET https://api.shiparta.com/metadata/object_materials \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
[
{
"description": "a strong, coarse unbleached cloth made from hemp, flax, cotton, or a similar yarn",
"id": "canvas",
"name": "Canvas"
}
]Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
Responses
-
• 200 array[object]
A collection of packing types
-
content-type string
-
x-arta-request-id string
-
description string
A long form description
-
id string
The ID representing the resource
-
name string
A brief title for the resource
-
subtypes array[object]
The subtypes for this resource
-
subtypes.description string
A long form description
-
subtypes.id string
The ID representing the resource
-
subtypes.name string
A brief title for the resource
-
-
Definition
GET https://api.shiparta.com/metadata/packingscURL example
curl \
-X GET https://api.shiparta.com/metadata/packings \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
[
{
"description": "Object is packed in plastic or bubble only",
"id": "soft_wrap",
"name": "Soft Wrap",
"subtypes": [
{
"description": "Wraped in dartek film.",
"id": "dartek_only",
"name": "Dartek only"
}
]
}
]Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
Responses
-
• 200 array[object]
A collection of quote types
-
content-type string
-
x-arta-request-id string
-
description string
A long form description
-
id string
The ID representing the resource
-
name string
A brief title for the resource
-
Definition
GET https://api.shiparta.com/metadata/quotescURL example
curl \
-X GET https://api.shiparta.com/metadata/quotes \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
[
{
"description": "Specialized climate-controlled transportation operated by trained technicians from wall-to-wall",
"id": "premium",
"name": "ARTA Premium"
}
]Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
Responses
-
• 200 array[object]
A collection of quote request statuses
-
content-type string
-
x-arta-request-id string
-
description string
A long form description
-
id string
The ID representing the resource
-
name string
A brief title for the resource
-
Definition
GET https://api.shiparta.com/metadata/request_statusescURL example
curl \
-X GET https://api.shiparta.com/metadata/request_statuses \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
[
{
"description": "Eligible shipment quotes have been added to the request",
"id": "quoted",
"name": "Quoted"
}
]Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
Responses
-
• 200 array[object]
A collection of service types
-
content-type string
-
x-arta-request-id string
-
description string
A long form description
-
id string
The ID representing the resource
-
name string
A brief title for the resource
-
subtypes array[object]
The subtypes for this resource
-
subtypes.description string
A long form description
-
subtypes.id string
The ID representing the resource
-
subtypes.name string
A brief title for the resource
-
subtypes.sub_subtypes array[object]
The subtypes for this resource
-
subtypes.sub_subtypes.description string
A long form description
-
subtypes.sub_subtypes.id string
The ID representing the resource
-
subtypes.sub_subtypes.is_requestable boolean
Whether this service is requestable by the client
-
subtypes.sub_subtypes.name string
A brief title for the resource
-
-
-
Definition
GET https://api.shiparta.com/metadata/servicescURL example
curl \
-X GET https://api.shiparta.com/metadata/services \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
[
{
"description": "All handling for items at location and in transit.",
"id": "handling",
"name": "Handling Services",
"subtypes": [
{
"description": "All installation services.",
"id": "installation",
"name": "Installation",
"sub_subtypes": [
{
"description": "Object assembly at the destination",
"id": "assembly",
"is_requestable": true,
"name": "Assembly"
}
]
}
]
}
]Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
Responses
-
• 200 array[object]
A collection of shipment statuses
-
content-type string
-
x-arta-request-id string
-
description string
A long form description
-
id string
The ID representing the resource
-
name string
A brief title for the resource
-
Definition
GET https://api.shiparta.com/metadata/shipment_statusescURL example
curl \
-X GET https://api.shiparta.com/metadata/shipment_statuses \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
[
{
"description": "A quote has been booked and is awaiting confirmation by an ARTA logistics specialist",
"id": "pending",
"name": "Pending"
}
]Get an Organization
Retrieve the Organization associated with the API Key in the Authorization header
Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
Responses
-
• 200 object
Successful Organization response
-
content-type string
-
x-arta-request-id string
-
api_version string
-
id integer(int64)
-
created_at string
-
name string
-
updated_at string
-
-
• 404 object
Resource Not Found
-
content-type string
-
x-arta-request-id string
-
errors object
-
errors.detail string
-
-
Definition
GET https://api.shiparta.com/organizationcURL example
curl \
-X GET https://api.shiparta.com/organization \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"api_version": "2020-10-22",
"id": 42,
"created_at": "2020-10-15T19:50:02.914779",
"name": "ARTA",
"updated_at": "2020-10-15T19:50:02.914779"
}Response example (404)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"errors": {
"detail": "string"
}
}Update an Organization
Update the Organization associated with the API Key in the Authorization header
Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
Body
-
webhook object
-
webhook.api_version string
The fallback API Version to be used as a default when API calls associated with this Organization do not include an
Arta-Versionheader -
webhook.name string
The name for this Organization.
-
Responses
-
• 200 object
Successful Organization update response
-
content-type string
-
x-arta-request-id string
-
api_version string
-
id integer(int64)
-
created_at string
-
name string
-
updated_at string
-
-
• 404 object
Resource Not Found
-
content-type string
-
x-arta-request-id string
-
errors object
-
errors.detail string
-
-
Definition
PATCH https://api.shiparta.com/organizationcURL example
curl \
-X PATCH https://api.shiparta.com/organization \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
-d '{"webhook":{"api_version":"2020-10-22","name":"Arta"}}'Request payload example
# Headers
Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y
# Payload
{
"webhook": {
"api_version": "2020-10-22",
"name": "Arta"
}
}Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"api_version": "2020-10-22",
"id": 42,
"created_at": "2020-10-15T19:50:02.914779",
"name": "ARTA",
"updated_at": "2020-10-15T19:50:02.914779"
}Response example (404)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"errors": {
"detail": "string"
}
}List Request records
Retrieve a paginated collection of Quote request records belonging to your Organization
Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
page_size integer
Results per page (max 50)
-
page integer
Page number of the results to fetch.
Responses
-
• 200 object
A collection of Quote Request records
-
content-type string
-
x-arta-request-id string
-
items array[]
-
metadata object
-
metadata.page integer(int64)
-
metadata.page_size integer(int64)
-
metadata.total_count integer(int64)
-
-
Definition
GET https://api.shiparta.com/requestscURL example
curl \
-X GET https://api.shiparta.com/requests \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"items": [
{
"created_at": "2021-01-21T21:00:29.568665",
"destination": {
"city": "New York",
"country": "US",
"postal_code": "11249",
"region": "NY"
},
"id": "6b12c76a-5217-4cd6-82d8-7aa5265ebaad",
"insurance": null,
"internal_reference": null,
"object_count": 1,
"organization_id": 9,
"origin": {
"city": "New York",
"country": "US",
"postal_code": "10019",
"region": "NY"
},
"public_reference": null,
"quote_types": [
"parcel",
"select",
"premium"
],
"status": "closed",
"updated_at": "2021-01-21T21:00:58.484566"
}
],
"metadata": {
"page": 1,
"page_size": 20,
"total_count": 1
}
}Create a Quote Request
The first step to booking a shipment on ARTA is to create a quote request. This quote request provides ARTA with all the necessary transport details for us to price your eventual shipment.
ARTA will return eligible quotes for your shipment across ARTA's Premium, Selecct, and Parcel quote types. If any quote types are ineligible given your logistic details, those will be noted in the disqualifications response.
You must minimally include objects, origin, and destination details in your API call for ARTA to successfully price the transport.
Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
Body
-
request Required / object
-
request.additional_services array[string]
The id of a service.
-
request.currency string
The currency that the quote should be returned in. Formatted as ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint
-
request.destination Required / object
The destination location for the shipment quote request
-
request.destination.access_restrictions array[string]
A list of access restricition IDs describing physical properties for the location. Options are defined in the Location Access Restrictions metadata endpoint
-
request.destination.address_line_1 string
The first line of the location's street address
-
request.destination.address_line_2 string
The second line of the location's street address
-
request.destination.address_line_3 string
The third line of the location's street address
-
request.destination.city string
The name of the city for the location
-
request.destination.region string
Political region name, for US states and Canada provinces, use 2 letter abbreviations
-
request.destination.postal_code Required / string
The postal code for the location
-
request.destination.country Required / string
The ISO 3166-1 alpha-2 country code of the location
-
request.destination.title string
The name for the location
-
request.destination.contacts array[object]
The contact details for the location
-
request.destination.contacts.name Required / string
The contact's name
-
request.destination.contacts.email_address string
The email address for this contact
-
request.destination.contacts.phone_number string
The phone_number for this contact
-
-
-
request.insurance string
The ID of the requested ARTA insurance type. Options are defined in the Insurances metadata endpoint
-
request.internal_reference string
This field can be used to pass through any data that you may want returned unaltered for your own later usage
-
request.objects array[object]
-
request.objects.internal_reference string
This field can be used to pass through any data that you may want returned unaltered for your own later usage
-
request.objects.current_packing array[string]
A list of packing subtype IDs describing how the item is currently packed
-
request.objects.depth Required / string
The depth of the object
-
request.objects.details object
-
request.objects.details.materials array[string]
A list of IDs describing the types of materials used
-
request.objects.details.creation_date string
Details about the timing in which an object was created
-
request.objects.details.creator string
The creator of the object
-
request.objects.details.notes string
Any notes about the item
-
request.objects.details.title string
The object title
-
request.objects.details.is_fragile boolean
Set this flag to true is the item is fragile. This may effect packing and handling costs
-
request.objects.details.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
-
-
request.objects.height Required / string
The height of the object
-
request.objects.images array[string](uri)
A list image urls of the object
-
request.objects.public_reference string
A client defined name for the object. The value provided for public_reference may be presented in notification emails and on shipment detail pages
-
request.objects.subtype Required / string
The object subtype ID. Options are defined in the Object types metadata endpoint
-
request.objects.type Required / string
The object type ID. Options are defined in the Object types metadata endpoint
-
request.objects.width Required / string
The width of the object
-
request.objects.unit_of_measurement Required / string
Values are
inandcm. -
request.objects.weight string
The weight of the object
-
request.objects.weight_unit Required / string
The unit of the object
Values are
lbandkg. -
request.objects.value Required / string
-
request.objects.value_currency Required / string
ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint
-
-
request.origin Required / object
The originating location for the shipment quote request
-
request.origin.access_restrictions array[string]
A list of access restricition ids describing physical properties of the location. Options are defined in the Location Access Restrictions metadata endpoint
-
request.origin.address_line_1 string
The first line of the location's street address
-
request.origin.address_line_2 string
The second line of the location's street address
-
request.origin.address_line_3 string
The third line of the location's street address
-
request.origin.city string
The name of the city for the location
-
request.origin.region string
Political region name, for US states and Canada provinces, use 2 letter abbreviations
-
request.origin.postal_code Required / string
The postal code for the location
-
request.origin.country Required / string
The ISO 3166-1 alpha-2 country code of the location
-
request.origin.title string
The name for the location
-
request.origin.contacts array[object]
The contact details for the location
-
request.origin.contacts.name Required / string
The contact's name
-
request.origin.contacts.email_address string
The main email address for this contact
-
request.origin.contacts.phone_number string
The main phone_number for this contact
-
-
-
request.public_reference string
A client defined name for the request. The value provided for the public_reference field may appear in notification emails and shipment detail pages
-
request.shipping_notes string
This field can be used to pass through any notes to ARTA that a customer might want to provide about the request
-
Responses
-
• 201 object
response
-
content-type string
-
x-arta-request-id string
-
additional_services array[string]
The id of a service.
-
bookable object
-
bookable.ready boolean
Returns true if the quotes in this request may be booked
-
bookable.missing array[string]
A list image urls of fields missing for the request to be bookable
-
-
currency string
The currency ID that the quote should be returned in. Options are defined in the Currencies metadata endpoint
-
destination object
-
destination.id string
The location id
-
destination.address_line_1 string
First line of address
-
destination.address_line_2 string
Second line of address
-
destination.address_line_3 string
Third line of address
-
destination.city string
City
-
destination.region string
Political region name, for US states and Canada provinces, use 2 letter abbreviations
-
destination.postal_code string
The postal code
-
destination.country string
The ISO 3166-1 alpha-2 country code of the current or last known location if available
-
destination.title string
The title or name of the location
-
destination.access_restrictions array[string]
Id of location restriction type
-
destination.contacts array[object]
An list of contacts at the location
-
destination.contacts.name string
-
destination.contacts.email_address string
-
destination.contacts.phone_number string
-
-
-
disqualifications array[object]
The list of reasons for which particular quote types were disqulified
-
disqualifications.quote_types array[string]
The id of a quote type
-
disqualifications.reason string
A brief explanation of the disqualification
-
disqualifications.reason_code string
An ID for the disqualification
-
-
id string
-
insurance string
The id of an insurance type. If requesting ARTA insurance, object values must be provided.
-
internal_reference string
This field can be used to pass through any data about the request you may want returned unaltered for your own later usage
-
object_count number
The count of objects included in the initial request payload
-
objects array[object]
-
objects.internal_reference string
This field can be used to pass through any data about the object you may want returned unaltered for your own later usage
-
objects.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
-
objects.depth string
The depth of the object
-
objects.details object
-
objects.details.materials array[string]
A list of IDs describing the types of materials used. Options are defined in the Object Materials metadata endpoint
-
objects.details.creation_date string
Details about the timing in which an object was created
-
objects.details.creator string
The creator of the object
-
objects.details.notes string
Any notes about the object
-
objects.details.title string
The object title
-
objects.details.is_fragile boolean
Set this flag to true is the item is fragile. This may effect packing and handling costs
-
objects.details.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
-
-
objects.height string
The height of the object
-
objects.images array[string](uri)
A list image urls of the object
-
objects.public_reference string
A user defined name of the object
-
objects.sub_type string
The object sub-type id
-
objects.type string
The object type id
-
objects.width string
The width of the object
-
objects.weight string
The height of the object
-
objects.unit_of_measurement string
Values are
inandcm. -
objects.value string
-
objects.value_currency string
ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint
-
-
origin object
-
origin.id string
The location id
-
origin.address_line_1 string
First line of address
-
origin.address_line_2 string
Second line of address
-
origin.address_line_3 string
Third line of address
-
origin.city string
City
-
origin.region string
Political region name, for US states and Canada provinces, use 2 letter abbreviations
-
origin.postal_code string
The postal code
-
origin.country string
The ISO 3166-1 alpha-2 country code of the current or last known location if available
-
origin.title string
The title or name of the location
-
origin.access_restrictions array[string]
Id of location restriction type
-
origin.contacts array[object]
An list of contacts at the location
-
origin.contacts.name string
-
origin.contacts.email_address string
-
origin.contacts.phone_number string
-
-
-
public_reference string
A client defined name for the resource. The value provided for the public_reference field may appear in notification emails and public web pages
-
quote_types array[string]
The id of a quote type
-
quotes array[]
The list of quotes returned for the request
-
shipping_notes string
This field can be used to pass through any notes to ARTA that a customer might want to provide about the request
-
status string
-
-
• 400 object
Bad Request
-
errors object
-
errors.detail string
-
-
Definition
POST https://api.shiparta.com/requestscURL example
curl \
-X POST https://api.shiparta.com/requests \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
-d '{"request":{"additional_services":["origin_condition_check"],"currency":"USD","destination":{"access_restrictions":["stairs_only"],"address_line_1":"string","address_line_2":"string","address_line_3":"string","city":"string","region":"string","postal_code":"string","country":"string","title":"string","contacts":[{"name":"string","email_address":"string","phone_number":"string"}]},"insurance":"arta_transit_insurance","internal_reference":"Purchase Order: 2801","objects":[{"internal_reference"...}'Request payload example
# Headers
Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y
# Payload
{
"request": {
"additional_services": [
"origin_condition_check"
],
"currency": "USD",
"destination": {
"access_restrictions": [
"stairs_only"
],
"address_line_1": "string",
"address_line_2": "string",
"address_line_3": "string",
"city": "string",
"region": "string",
"postal_code": "string",
"country": "string",
"title": "string",
"contacts": [
{
"name": "string",
"email_address": "string",
"phone_number": "string"
}
]
},
"insurance": "arta_transit_insurance",
"internal_reference": "Purchase Order: 2801",
"objects": [
{
"internal_reference": "Accession ID: 823",
"current_packing": [
"no_packing"
],
"depth": "3",
"details": {
"materials": [
"paint"
],
"creation_date": "1980",
"creator": "Bob Smithson",
"notes": "Artist signature in the lower left corner",
"title": "Black Rectangle",
"is_fragile": true,
"is_cites": true
},
"height": "32",
"images": [
"http://example.com/image.jpg"
],
"public_reference": "Round Smithson work",
"subtype": "painting_unframed",
"type": "art",
"width": "15",
"unit_of_measurement": "in",
"weight": "3.0",
"weight_unit": "lb",
"value": "string",
"value_currency": "string"
}
],
"origin": {
"access_restrictions": [
"no_packing"
],
"address_line_1": "string",
"address_line_2": "string",
"address_line_3": "string",
"city": "string",
"region": "string",
"postal_code": "string",
"country": "string",
"title": "string",
"contacts": [
{
"name": "string",
"email_address": "string",
"phone_number": "string"
}
]
},
"public_reference": "Order #1437",
"shipping_notes": "New customer"
}
}Response example (201)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"additional_services": [
],
"bookable": {
"missing": [
],
"ready": true
},
"created_at": "2021-01-21T17:22:08.818747",
"currency": "USD",
"destination": {
"access_restrictions": [
],
"address_line_1": "87 Richardson St",
"address_line_2": null,
"address_line_3": null,
"city": "New York",
"contacts": [
{
"email_address": "al@example.com",
"name": "Alfred Barr",
"phone_number": "(222) 222-2222"
}
],
"country": "US",
"postal_code": "11249",
"region": "NY",
"title": "Home"
},
"disqualifications": [
],
"id": "9d8892bc-f4c6-4b45-88e2-0ccd28eb73cc",
"insurance": null,
"internal_reference": null,
"object_count": 1,
"objects": [
{
"current_packing": [
],
"depth": "2",
"details": {
"creation_date": null,
"creator": "Robert Irwin",
"is_cites": false,
"is_fragile": false,
"materials": [
],
"title": "All That Jazz"
},
"height": "10.5",
"images": [
],
"internal_reference": null,
"public_reference": null,
"subtype": "painting_unframed",
"type": "art",
"unit_of_measurement": "in",
"value": "15000",
"value_currency": "USD",
"weight": "3.5",
"weight_unit": "lb",
"width": "10"
}
],
"origin": {
"access_restrictions": [
],
"address_line_1": "11 W 53rd St",
"address_line_2": null,
"address_line_3": null,
"city": "New York",
"contacts": [
{
"email_address": "mary@example.com",
"name": "Mary Quinn Sullivan",
"phone_number": "(333) 333-3333"
}
],
"country": "US",
"postal_code": "10019",
"region": "NY",
"title": "Warehouse"
},
"public_reference": null,
"quote_types": [
"premium",
"select",
"parcel"
],
"quotes": [
{
"id": 61,
"included_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Specialized Shuttle",
"sub_subtype": "specialized_shuttle",
"subtype": "specialized",
"type": "transport"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Shadowbox",
"sub_subtype": "shadow_box",
"subtype": "packing_materials",
"type": "packing"
}
],
"included_insurance_policy": null,
"optional_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
{
"name": "Soft Packed Disposal",
"sub_subtype": "soft_packed_disposal",
"subtype": "debris_disposal",
"type": "handling"
}
],
"name": "Debris Disposal",
"sub_subtype": "debris_disposal",
"subtype": "debris_disposal",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Assembly",
"sub_subtype": "assembly",
"subtype": "installation",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Placement",
"sub_subtype": "placement",
"subtype": "installation",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Installation",
"sub_subtype": "installation",
"subtype": "installation",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Check (destination)",
"sub_subtype": "destination_condition_check",
"subtype": "condition",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Check (origin)",
"sub_subtype": "origin_condition_check",
"subtype": "condition",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Report (destination)",
"sub_subtype": "destination_full_condition_report",
"subtype": "condition",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Report (origin)",
"sub_subtype": "origin_full_condition_report",
"subtype": "condition",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
{
"name": "Unpacking Soft Materials (destination)",
"sub_subtype": "destination_unpacking_soft",
"subtype": "unpacking",
"type": "handling"
}
],
"name": "Unpacking (destination)",
"sub_subtype": "destination_unpacking",
"subtype": "unpacking",
"type": "handling"
}
],
"quote_type": "premium",
"status": "published",
"total": "2",
"total_currency": "USD"
},
{
"id": 62,
"included_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
{
"name": "Soft Packed Disposal",
"sub_subtype": "soft_packed_disposal",
"subtype": "debris_disposal",
"type": "handling"
}
],
"is_requested": false,
"is_required": true,
"name": "Debris Disposal",
"sub_subtype": "debris_disposal",
"subtype": "debris_disposal",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Fuel Surcharge",
"sub_subtype": "fuel_surcharge",
"subtype": "fees",
"type": "taxes_duties_fees"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Strongbox",
"sub_subtype": "strongbox",
"subtype": "packing_materials",
"type": "packing"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Consolidated Trucking",
"sub_subtype": "road_groupage",
"subtype": "consolidated",
"type": "transport"
}
],
"included_insurance_policy": null,
"optional_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
{
"name": "Unpacking Soft Materials (destination)",
"sub_subtype": "destination_unpacking_soft",
"subtype": "unpacking",
"type": "handling"
}
],
"name": "Unpacking (destination)",
"sub_subtype": "destination_unpacking",
"subtype": "unpacking",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Check (destination)",
"sub_subtype": "destination_condition_check",
"subtype": "condition",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Check (origin)",
"sub_subtype": "origin_condition_check",
"subtype": "condition",
"type": "handling"
}
],
"quote_type": "select",
"status": "published",
"total": "4",
"total_currency": "USD"
},
{
"id": 63,
"included_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Fuel Surcharge",
"sub_subtype": "fuel_surcharge",
"subtype": "fees",
"type": "taxes_duties_fees"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Collection",
"sub_subtype": "collection",
"subtype": "collection",
"type": "location"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Ply Box",
"sub_subtype": "ply_box",
"subtype": "packing_materials",
"type": "packing"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "UPS Ground",
"sub_subtype": "parcel",
"subtype": "parcel",
"type": "transport"
}
],
"included_insurance_policy": null,
"optional_services": [
],
"quote_type": "parcel",
"status": "published",
"total": "4",
"total_currency": "USD"
},
{
"id": 64,
"included_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Fuel Surcharge",
"sub_subtype": "fuel_surcharge",
"subtype": "fees",
"type": "taxes_duties_fees"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Collection",
"sub_subtype": "collection",
"subtype": "collection",
"type": "location"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Ply Box",
"sub_subtype": "ply_box",
"subtype": "packing_materials",
"type": "packing"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "UPS Second Day Air",
"sub_subtype": "parcel",
"subtype": "parcel",
"type": "transport"
}
],
"included_insurance_policy": null,
"optional_services": [
],
"quote_type": "parcel",
"status": "published",
"total": "4",
"total_currency": "USD"
},
{
"id": 65,
"included_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Fuel Surcharge",
"sub_subtype": "fuel_surcharge",
"subtype": "fees",
"type": "taxes_duties_fees"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Collection",
"sub_subtype": "collection",
"subtype": "collection",
"type": "location"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Ply Box",
"sub_subtype": "ply_box",
"subtype": "packing_materials",
"type": "packing"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "UPS Next Day Air",
"sub_subtype": "parcel",
"subtype": "parcel",
"type": "transport"
}
],
"included_insurance_policy": null,
"optional_services": [
],
"quote_type": "parcel",
"status": "published",
"total": "4",
"total_currency": "USD"
}
],
"shipping_notes": null,
"status": "quoted",
"updated_at": "2021-01-21T17:22:10.129653"
}Response example (400)
{
"errors": {
"detail": "string"
}
}Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
request_id Required / string
request_id parameter
Responses
-
• 200 object
Successful Request get response
-
content-type string
-
x-arta-request-id string
-
additional_services array[string]
The id of a service.
-
bookable object
-
bookable.ready boolean
Returns true if the quotes in this request may be booked
-
bookable.missing array[string]
A list image urls of fields missing for the request to be bookable
-
-
currency string
The currency ID that the quote should be returned in. Options are defined in the Currencies metadata endpoint
-
destination object
-
destination.id string
The location id
-
destination.address_line_1 string
First line of address
-
destination.address_line_2 string
Second line of address
-
destination.address_line_3 string
Third line of address
-
destination.city string
City
-
destination.region string
Political region name, for US states and Canada provinces, use 2 letter abbreviations
-
destination.postal_code string
The postal code
-
destination.country string
The ISO 3166-1 alpha-2 country code of the current or last known location if available
-
destination.title string
The title or name of the location
-
destination.access_restrictions array[string]
Id of location restriction type
-
destination.contacts array[object]
An list of contacts at the location
-
destination.contacts.name string
-
destination.contacts.email_address string
-
destination.contacts.phone_number string
-
-
-
disqualifications array[object]
The list of reasons for which particular quote types were disqulified
-
disqualifications.quote_types array[string]
The id of a quote type
-
disqualifications.reason string
A brief explanation of the disqualification
-
disqualifications.reason_code string
An ID for the disqualification
-
-
id string
-
insurance string
The id of an insurance type. If requesting ARTA insurance, object values must be provided.
-
internal_reference string
This field can be used to pass through any data about the request you may want returned unaltered for your own later usage
-
object_count number
The count of objects included in the initial request payload
-
objects array[object]
-
objects.internal_reference string
This field can be used to pass through any data about the object you may want returned unaltered for your own later usage
-
objects.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
-
objects.depth string
The depth of the object
-
objects.details object
-
objects.details.materials array[string]
A list of IDs describing the types of materials used. Options are defined in the Object Materials metadata endpoint
-
objects.details.creation_date string
Details about the timing in which an object was created
-
objects.details.creator string
The creator of the object
-
objects.details.notes string
Any notes about the object
-
objects.details.title string
The object title
-
objects.details.is_fragile boolean
Set this flag to true is the item is fragile. This may effect packing and handling costs
-
objects.details.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
-
-
objects.height string
The height of the object
-
objects.images array[string](uri)
A list image urls of the object
-
objects.public_reference string
A user defined name of the object
-
objects.sub_type string
The object sub-type id
-
objects.type string
The object type id
-
objects.width string
The width of the object
-
objects.weight string
The height of the object
-
objects.unit_of_measurement string
Values are
inandcm. -
objects.value string
-
objects.value_currency string
ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint
-
-
origin object
-
origin.id string
The location id
-
origin.address_line_1 string
First line of address
-
origin.address_line_2 string
Second line of address
-
origin.address_line_3 string
Third line of address
-
origin.city string
City
-
origin.region string
Political region name, for US states and Canada provinces, use 2 letter abbreviations
-
origin.postal_code string
The postal code
-
origin.country string
The ISO 3166-1 alpha-2 country code of the current or last known location if available
-
origin.title string
The title or name of the location
-
origin.access_restrictions array[string]
Id of location restriction type
-
origin.contacts array[object]
An list of contacts at the location
-
origin.contacts.name string
-
origin.contacts.email_address string
-
origin.contacts.phone_number string
-
-
-
public_reference string
A client defined name for the resource. The value provided for the public_reference field may appear in notification emails and public web pages
-
quote_types array[string]
The id of a quote type
-
quotes array[]
The list of quotes returned for the request
-
shipping_notes string
This field can be used to pass through any notes to ARTA that a customer might want to provide about the request
-
status string
-
-
• 404 object
Resource Not Found
-
content-type string
-
x-arta-request-id string
-
errors object
-
errors.detail string
-
-
Definition
GET https://api.shiparta.com/requests/{request_id}cURL example
curl \
-X GET https://api.shiparta.com/requests/{request_id} \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"additional_services": [
],
"bookable": {
"missing": [
],
"ready": true
},
"created_at": "2021-01-21T17:22:08.818747",
"currency": "USD",
"destination": {
"access_restrictions": [
],
"address_line_1": "87 Richardson St",
"address_line_2": null,
"address_line_3": null,
"city": "New York",
"contacts": [
{
"email_address": "al@example.com",
"name": "Alfred Barr",
"phone_number": "(222) 222-2222"
}
],
"country": "US",
"postal_code": "11249",
"region": "NY",
"title": "Home"
},
"disqualifications": [
],
"id": "9d8892bc-f4c6-4b45-88e2-0ccd28eb73cc",
"insurance": null,
"internal_reference": null,
"object_count": 1,
"objects": [
{
"current_packing": [
],
"depth": "2",
"details": {
"creation_date": null,
"creator": "Robert Irwin",
"is_cites": false,
"is_fragile": false,
"materials": [
],
"title": "All That Jazz"
},
"height": "10.5",
"images": [
],
"internal_reference": null,
"public_reference": null,
"subtype": "painting_unframed",
"type": "art",
"unit_of_measurement": "in",
"value": "15000",
"value_currency": "USD",
"weight": "3.5",
"weight_unit": "lb",
"width": "10"
}
],
"origin": {
"access_restrictions": [
],
"address_line_1": "11 W 53rd St",
"address_line_2": null,
"address_line_3": null,
"city": "New York",
"contacts": [
{
"email_address": "mary@example.com",
"name": "Mary Quinn Sullivan",
"phone_number": "(333) 333-3333"
}
],
"country": "US",
"postal_code": "10019",
"region": "NY",
"title": "Warehouse"
},
"public_reference": null,
"quote_types": [
"premium",
"select",
"parcel"
],
"quotes": [
{
"id": 61,
"included_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Specialized Shuttle",
"sub_subtype": "specialized_shuttle",
"subtype": "specialized",
"type": "transport"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Shadowbox",
"sub_subtype": "shadow_box",
"subtype": "packing_materials",
"type": "packing"
}
],
"included_insurance_policy": null,
"optional_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
{
"name": "Soft Packed Disposal",
"sub_subtype": "soft_packed_disposal",
"subtype": "debris_disposal",
"type": "handling"
}
],
"name": "Debris Disposal",
"sub_subtype": "debris_disposal",
"subtype": "debris_disposal",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Assembly",
"sub_subtype": "assembly",
"subtype": "installation",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Placement",
"sub_subtype": "placement",
"subtype": "installation",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Installation",
"sub_subtype": "installation",
"subtype": "installation",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Check (destination)",
"sub_subtype": "destination_condition_check",
"subtype": "condition",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Check (origin)",
"sub_subtype": "origin_condition_check",
"subtype": "condition",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Report (destination)",
"sub_subtype": "destination_full_condition_report",
"subtype": "condition",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Report (origin)",
"sub_subtype": "origin_full_condition_report",
"subtype": "condition",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
{
"name": "Unpacking Soft Materials (destination)",
"sub_subtype": "destination_unpacking_soft",
"subtype": "unpacking",
"type": "handling"
}
],
"name": "Unpacking (destination)",
"sub_subtype": "destination_unpacking",
"subtype": "unpacking",
"type": "handling"
}
],
"quote_type": "premium",
"status": "published",
"total": "2",
"total_currency": "USD"
},
{
"id": 62,
"included_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
{
"name": "Soft Packed Disposal",
"sub_subtype": "soft_packed_disposal",
"subtype": "debris_disposal",
"type": "handling"
}
],
"is_requested": false,
"is_required": true,
"name": "Debris Disposal",
"sub_subtype": "debris_disposal",
"subtype": "debris_disposal",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Fuel Surcharge",
"sub_subtype": "fuel_surcharge",
"subtype": "fees",
"type": "taxes_duties_fees"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Strongbox",
"sub_subtype": "strongbox",
"subtype": "packing_materials",
"type": "packing"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Consolidated Trucking",
"sub_subtype": "road_groupage",
"subtype": "consolidated",
"type": "transport"
}
],
"included_insurance_policy": null,
"optional_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
{
"name": "Unpacking Soft Materials (destination)",
"sub_subtype": "destination_unpacking_soft",
"subtype": "unpacking",
"type": "handling"
}
],
"name": "Unpacking (destination)",
"sub_subtype": "destination_unpacking",
"subtype": "unpacking",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Check (destination)",
"sub_subtype": "destination_condition_check",
"subtype": "condition",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Check (origin)",
"sub_subtype": "origin_condition_check",
"subtype": "condition",
"type": "handling"
}
],
"quote_type": "select",
"status": "published",
"total": "4",
"total_currency": "USD"
},
{
"id": 63,
"included_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Fuel Surcharge",
"sub_subtype": "fuel_surcharge",
"subtype": "fees",
"type": "taxes_duties_fees"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Collection",
"sub_subtype": "collection",
"subtype": "collection",
"type": "location"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Ply Box",
"sub_subtype": "ply_box",
"subtype": "packing_materials",
"type": "packing"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "UPS Ground",
"sub_subtype": "parcel",
"subtype": "parcel",
"type": "transport"
}
],
"included_insurance_policy": null,
"optional_services": [
],
"quote_type": "parcel",
"status": "published",
"total": "4",
"total_currency": "USD"
},
{
"id": 64,
"included_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Fuel Surcharge",
"sub_subtype": "fuel_surcharge",
"subtype": "fees",
"type": "taxes_duties_fees"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Collection",
"sub_subtype": "collection",
"subtype": "collection",
"type": "location"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Ply Box",
"sub_subtype": "ply_box",
"subtype": "packing_materials",
"type": "packing"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "UPS Second Day Air",
"sub_subtype": "parcel",
"subtype": "parcel",
"type": "transport"
}
],
"included_insurance_policy": null,
"optional_services": [
],
"quote_type": "parcel",
"status": "published",
"total": "4",
"total_currency": "USD"
},
{
"id": 65,
"included_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Fuel Surcharge",
"sub_subtype": "fuel_surcharge",
"subtype": "fees",
"type": "taxes_duties_fees"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Collection",
"sub_subtype": "collection",
"subtype": "collection",
"type": "location"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Ply Box",
"sub_subtype": "ply_box",
"subtype": "packing_materials",
"type": "packing"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "UPS Next Day Air",
"sub_subtype": "parcel",
"subtype": "parcel",
"type": "transport"
}
],
"included_insurance_policy": null,
"optional_services": [
],
"quote_type": "parcel",
"status": "published",
"total": "4",
"total_currency": "USD"
}
],
"shipping_notes": null,
"status": "quoted",
"updated_at": "2021-01-21T17:22:10.129653"
}Response example (404)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"errors": {
"detail": "string"
}
}Create a Custom Quote Request
ARTA logistics specialists can provide custom quotes when your initial request has disqualified or you have special requirements for a shipment.
Upon submitting the custom request, an ARTA specialist will use the details you have provided to build one or more new transport quotes for your review.
Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
request_id Required / string
request_id parameter
Responses
-
• 200 object
Successful Shipment get response
-
content-type string
-
x-arta-request-id string
-
additional_services array[string]
The id of a service.
-
bookable object
-
bookable.ready boolean
Returns true if the quotes in this request may be booked
-
bookable.missing array[string]
A list image urls of fields missing for the request to be bookable
-
-
currency string
The currency ID that the quote should be returned in. Options are defined in the Currencies metadata endpoint
-
destination object
-
destination.id string
The location id
-
destination.address_line_1 string
First line of address
-
destination.address_line_2 string
Second line of address
-
destination.address_line_3 string
Third line of address
-
destination.city string
City
-
destination.region string
Political region name, for US states and Canada provinces, use 2 letter abbreviations
-
destination.postal_code string
The postal code
-
destination.country string
The ISO 3166-1 alpha-2 country code of the current or last known location if available
-
destination.title string
The title or name of the location
-
destination.access_restrictions array[string]
Id of location restriction type
-
destination.contacts array[object]
An list of contacts at the location
-
destination.contacts.name string
-
destination.contacts.email_address string
-
destination.contacts.phone_number string
-
-
-
disqualifications array[object]
The list of reasons for which particular quote types were disqulified
-
disqualifications.quote_types array[string]
The id of a quote type
-
disqualifications.reason string
A brief explanation of the disqualification
-
disqualifications.reason_code string
An ID for the disqualification
-
-
id string
-
insurance string
The id of an insurance type. If requesting ARTA insurance, object values must be provided.
-
internal_reference string
This field can be used to pass through any data about the request you may want returned unaltered for your own later usage
-
object_count number
The count of objects included in the initial request payload
-
objects array[object]
-
objects.internal_reference string
This field can be used to pass through any data about the object you may want returned unaltered for your own later usage
-
objects.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
-
objects.depth string
The depth of the object
-
objects.details object
-
objects.details.materials array[string]
A list of IDs describing the types of materials used. Options are defined in the Object Materials metadata endpoint
-
objects.details.creation_date string
Details about the timing in which an object was created
-
objects.details.creator string
The creator of the object
-
objects.details.notes string
Any notes about the object
-
objects.details.title string
The object title
-
objects.details.is_fragile boolean
Set this flag to true is the item is fragile. This may effect packing and handling costs
-
objects.details.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
-
-
objects.height string
The height of the object
-
objects.images array[string](uri)
A list image urls of the object
-
objects.public_reference string
A user defined name of the object
-
objects.sub_type string
The object sub-type id
-
objects.type string
The object type id
-
objects.width string
The width of the object
-
objects.weight string
The height of the object
-
objects.unit_of_measurement string
Values are
inandcm. -
objects.value string
-
objects.value_currency string
ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint
-
-
origin object
-
origin.id string
The location id
-
origin.address_line_1 string
First line of address
-
origin.address_line_2 string
Second line of address
-
origin.address_line_3 string
Third line of address
-
origin.city string
City
-
origin.region string
Political region name, for US states and Canada provinces, use 2 letter abbreviations
-
origin.postal_code string
The postal code
-
origin.country string
The ISO 3166-1 alpha-2 country code of the current or last known location if available
-
origin.title string
The title or name of the location
-
origin.access_restrictions array[string]
Id of location restriction type
-
origin.contacts array[object]
An list of contacts at the location
-
origin.contacts.name string
-
origin.contacts.email_address string
-
origin.contacts.phone_number string
-
-
-
public_reference string
A client defined name for the resource. The value provided for the public_reference field may appear in notification emails and public web pages
-
quote_types array[string]
The id of a quote type
-
quotes array[]
The list of quotes returned for the request
-
shipping_notes string
This field can be used to pass through any notes to ARTA that a customer might want to provide about the request
-
status string
-
-
• 404 object
Resource Not Found
-
content-type string
-
x-arta-request-id string
-
errors object
-
errors.detail string
-
-
Definition
PATCH https://api.shiparta.com/requests/{request_id}/customcURL example
curl \
-X PATCH https://api.shiparta.com/requests/{request_id}/custom \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"additional_services": [
],
"bookable": {
"missing": [
],
"ready": true
},
"created_at": "2021-01-21T17:22:08.818747",
"currency": "USD",
"destination": {
"access_restrictions": [
],
"address_line_1": "87 Richardson St",
"address_line_2": null,
"address_line_3": null,
"city": "New York",
"contacts": [
{
"email_address": "al@example.com",
"name": "Alfred Barr",
"phone_number": "(222) 222-2222"
}
],
"country": "US",
"postal_code": "11249",
"region": "NY",
"title": "Home"
},
"disqualifications": [
],
"id": "9d8892bc-f4c6-4b45-88e2-0ccd28eb73cc",
"insurance": null,
"internal_reference": null,
"object_count": 1,
"objects": [
{
"current_packing": [
],
"depth": "2",
"details": {
"creation_date": null,
"creator": "Robert Irwin",
"is_cites": false,
"is_fragile": false,
"materials": [
],
"title": "All That Jazz"
},
"height": "10.5",
"images": [
],
"internal_reference": null,
"public_reference": null,
"subtype": "painting_unframed",
"type": "art",
"unit_of_measurement": "in",
"value": "15000",
"value_currency": "USD",
"weight": "3.5",
"weight_unit": "lb",
"width": "10"
}
],
"origin": {
"access_restrictions": [
],
"address_line_1": "11 W 53rd St",
"address_line_2": null,
"address_line_3": null,
"city": "New York",
"contacts": [
{
"email_address": "mary@example.com",
"name": "Mary Quinn Sullivan",
"phone_number": "(333) 333-3333"
}
],
"country": "US",
"postal_code": "10019",
"region": "NY",
"title": "Warehouse"
},
"public_reference": null,
"quote_types": [
"premium",
"select",
"parcel"
],
"quotes": [
{
"id": 61,
"included_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Specialized Shuttle",
"sub_subtype": "specialized_shuttle",
"subtype": "specialized",
"type": "transport"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Shadowbox",
"sub_subtype": "shadow_box",
"subtype": "packing_materials",
"type": "packing"
}
],
"included_insurance_policy": null,
"optional_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
{
"name": "Soft Packed Disposal",
"sub_subtype": "soft_packed_disposal",
"subtype": "debris_disposal",
"type": "handling"
}
],
"name": "Debris Disposal",
"sub_subtype": "debris_disposal",
"subtype": "debris_disposal",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Assembly",
"sub_subtype": "assembly",
"subtype": "installation",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Placement",
"sub_subtype": "placement",
"subtype": "installation",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Installation",
"sub_subtype": "installation",
"subtype": "installation",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Check (destination)",
"sub_subtype": "destination_condition_check",
"subtype": "condition",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Check (origin)",
"sub_subtype": "origin_condition_check",
"subtype": "condition",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Report (destination)",
"sub_subtype": "destination_full_condition_report",
"subtype": "condition",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Report (origin)",
"sub_subtype": "origin_full_condition_report",
"subtype": "condition",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
{
"name": "Unpacking Soft Materials (destination)",
"sub_subtype": "destination_unpacking_soft",
"subtype": "unpacking",
"type": "handling"
}
],
"name": "Unpacking (destination)",
"sub_subtype": "destination_unpacking",
"subtype": "unpacking",
"type": "handling"
}
],
"quote_type": "premium",
"status": "published",
"total": "2",
"total_currency": "USD"
},
{
"id": 62,
"included_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
{
"name": "Soft Packed Disposal",
"sub_subtype": "soft_packed_disposal",
"subtype": "debris_disposal",
"type": "handling"
}
],
"is_requested": false,
"is_required": true,
"name": "Debris Disposal",
"sub_subtype": "debris_disposal",
"subtype": "debris_disposal",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Fuel Surcharge",
"sub_subtype": "fuel_surcharge",
"subtype": "fees",
"type": "taxes_duties_fees"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Strongbox",
"sub_subtype": "strongbox",
"subtype": "packing_materials",
"type": "packing"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Consolidated Trucking",
"sub_subtype": "road_groupage",
"subtype": "consolidated",
"type": "transport"
}
],
"included_insurance_policy": null,
"optional_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
{
"name": "Unpacking Soft Materials (destination)",
"sub_subtype": "destination_unpacking_soft",
"subtype": "unpacking",
"type": "handling"
}
],
"name": "Unpacking (destination)",
"sub_subtype": "destination_unpacking",
"subtype": "unpacking",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Check (destination)",
"sub_subtype": "destination_condition_check",
"subtype": "condition",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Check (origin)",
"sub_subtype": "origin_condition_check",
"subtype": "condition",
"type": "handling"
}
],
"quote_type": "select",
"status": "published",
"total": "4",
"total_currency": "USD"
},
{
"id": 63,
"included_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Fuel Surcharge",
"sub_subtype": "fuel_surcharge",
"subtype": "fees",
"type": "taxes_duties_fees"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Collection",
"sub_subtype": "collection",
"subtype": "collection",
"type": "location"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Ply Box",
"sub_subtype": "ply_box",
"subtype": "packing_materials",
"type": "packing"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "UPS Ground",
"sub_subtype": "parcel",
"subtype": "parcel",
"type": "transport"
}
],
"included_insurance_policy": null,
"optional_services": [
],
"quote_type": "parcel",
"status": "published",
"total": "4",
"total_currency": "USD"
},
{
"id": 64,
"included_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Fuel Surcharge",
"sub_subtype": "fuel_surcharge",
"subtype": "fees",
"type": "taxes_duties_fees"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Collection",
"sub_subtype": "collection",
"subtype": "collection",
"type": "location"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Ply Box",
"sub_subtype": "ply_box",
"subtype": "packing_materials",
"type": "packing"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "UPS Second Day Air",
"sub_subtype": "parcel",
"subtype": "parcel",
"type": "transport"
}
],
"included_insurance_policy": null,
"optional_services": [
],
"quote_type": "parcel",
"status": "published",
"total": "4",
"total_currency": "USD"
},
{
"id": 65,
"included_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Fuel Surcharge",
"sub_subtype": "fuel_surcharge",
"subtype": "fees",
"type": "taxes_duties_fees"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Collection",
"sub_subtype": "collection",
"subtype": "collection",
"type": "location"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Ply Box",
"sub_subtype": "ply_box",
"subtype": "packing_materials",
"type": "packing"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "UPS Next Day Air",
"sub_subtype": "parcel",
"subtype": "parcel",
"type": "transport"
}
],
"included_insurance_policy": null,
"optional_services": [
],
"quote_type": "parcel",
"status": "published",
"total": "4",
"total_currency": "USD"
}
],
"shipping_notes": null,
"status": "quoted",
"updated_at": "2021-01-21T17:22:10.129653"
}Response example (404)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"errors": {
"detail": "string"
}
}Cancel a custom Quote Request
Cancel a quote request to indicate to ARTA that you no longer require a custom quote
Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
request_id Required / string
request_id parameter
Responses
-
• 200 object
Successful Shipment get response
-
content-type string
-
x-arta-request-id string
-
additional_services array[string]
The id of a service.
-
bookable object
-
bookable.ready boolean
Returns true if the quotes in this request may be booked
-
bookable.missing array[string]
A list image urls of fields missing for the request to be bookable
-
-
currency string
The currency ID that the quote should be returned in. Options are defined in the Currencies metadata endpoint
-
destination object
-
destination.id string
The location id
-
destination.address_line_1 string
First line of address
-
destination.address_line_2 string
Second line of address
-
destination.address_line_3 string
Third line of address
-
destination.city string
City
-
destination.region string
Political region name, for US states and Canada provinces, use 2 letter abbreviations
-
destination.postal_code string
The postal code
-
destination.country string
The ISO 3166-1 alpha-2 country code of the current or last known location if available
-
destination.title string
The title or name of the location
-
destination.access_restrictions array[string]
Id of location restriction type
-
destination.contacts array[object]
An list of contacts at the location
-
destination.contacts.name string
-
destination.contacts.email_address string
-
destination.contacts.phone_number string
-
-
-
disqualifications array[object]
The list of reasons for which particular quote types were disqulified
-
disqualifications.quote_types array[string]
The id of a quote type
-
disqualifications.reason string
A brief explanation of the disqualification
-
disqualifications.reason_code string
An ID for the disqualification
-
-
id string
-
insurance string
The id of an insurance type. If requesting ARTA insurance, object values must be provided.
-
internal_reference string
This field can be used to pass through any data about the request you may want returned unaltered for your own later usage
-
object_count number
The count of objects included in the initial request payload
-
objects array[object]
-
objects.internal_reference string
This field can be used to pass through any data about the object you may want returned unaltered for your own later usage
-
objects.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
-
objects.depth string
The depth of the object
-
objects.details object
-
objects.details.materials array[string]
A list of IDs describing the types of materials used. Options are defined in the Object Materials metadata endpoint
-
objects.details.creation_date string
Details about the timing in which an object was created
-
objects.details.creator string
The creator of the object
-
objects.details.notes string
Any notes about the object
-
objects.details.title string
The object title
-
objects.details.is_fragile boolean
Set this flag to true is the item is fragile. This may effect packing and handling costs
-
objects.details.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
-
-
objects.height string
The height of the object
-
objects.images array[string](uri)
A list image urls of the object
-
objects.public_reference string
A user defined name of the object
-
objects.sub_type string
The object sub-type id
-
objects.type string
The object type id
-
objects.width string
The width of the object
-
objects.weight string
The height of the object
-
objects.unit_of_measurement string
Values are
inandcm. -
objects.value string
-
objects.value_currency string
ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint
-
-
origin object
-
origin.id string
The location id
-
origin.address_line_1 string
First line of address
-
origin.address_line_2 string
Second line of address
-
origin.address_line_3 string
Third line of address
-
origin.city string
City
-
origin.region string
Political region name, for US states and Canada provinces, use 2 letter abbreviations
-
origin.postal_code string
The postal code
-
origin.country string
The ISO 3166-1 alpha-2 country code of the current or last known location if available
-
origin.title string
The title or name of the location
-
origin.access_restrictions array[string]
Id of location restriction type
-
origin.contacts array[object]
An list of contacts at the location
-
origin.contacts.name string
-
origin.contacts.email_address string
-
origin.contacts.phone_number string
-
-
-
public_reference string
A client defined name for the resource. The value provided for the public_reference field may appear in notification emails and public web pages
-
quote_types array[string]
The id of a quote type
-
quotes array[]
The list of quotes returned for the request
-
shipping_notes string
This field can be used to pass through any notes to ARTA that a customer might want to provide about the request
-
status string
-
-
• 404 object
Resource Not Found
-
content-type string
-
x-arta-request-id string
-
errors object
-
errors.detail string
-
-
Definition
PATCH https://api.shiparta.com/requests/{request_id}/cancelcURL example
curl \
-X PATCH https://api.shiparta.com/requests/{request_id}/cancel \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"additional_services": [
],
"bookable": {
"missing": [
],
"ready": true
},
"created_at": "2021-01-21T17:22:08.818747",
"currency": "USD",
"destination": {
"access_restrictions": [
],
"address_line_1": "87 Richardson St",
"address_line_2": null,
"address_line_3": null,
"city": "New York",
"contacts": [
{
"email_address": "al@example.com",
"name": "Alfred Barr",
"phone_number": "(222) 222-2222"
}
],
"country": "US",
"postal_code": "11249",
"region": "NY",
"title": "Home"
},
"disqualifications": [
],
"id": "9d8892bc-f4c6-4b45-88e2-0ccd28eb73cc",
"insurance": null,
"internal_reference": null,
"object_count": 1,
"objects": [
{
"current_packing": [
],
"depth": "2",
"details": {
"creation_date": null,
"creator": "Robert Irwin",
"is_cites": false,
"is_fragile": false,
"materials": [
],
"title": "All That Jazz"
},
"height": "10.5",
"images": [
],
"internal_reference": null,
"public_reference": null,
"subtype": "painting_unframed",
"type": "art",
"unit_of_measurement": "in",
"value": "15000",
"value_currency": "USD",
"weight": "3.5",
"weight_unit": "lb",
"width": "10"
}
],
"origin": {
"access_restrictions": [
],
"address_line_1": "11 W 53rd St",
"address_line_2": null,
"address_line_3": null,
"city": "New York",
"contacts": [
{
"email_address": "mary@example.com",
"name": "Mary Quinn Sullivan",
"phone_number": "(333) 333-3333"
}
],
"country": "US",
"postal_code": "10019",
"region": "NY",
"title": "Warehouse"
},
"public_reference": null,
"quote_types": [
"premium",
"select",
"parcel"
],
"quotes": [
{
"id": 61,
"included_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Specialized Shuttle",
"sub_subtype": "specialized_shuttle",
"subtype": "specialized",
"type": "transport"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Shadowbox",
"sub_subtype": "shadow_box",
"subtype": "packing_materials",
"type": "packing"
}
],
"included_insurance_policy": null,
"optional_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
{
"name": "Soft Packed Disposal",
"sub_subtype": "soft_packed_disposal",
"subtype": "debris_disposal",
"type": "handling"
}
],
"name": "Debris Disposal",
"sub_subtype": "debris_disposal",
"subtype": "debris_disposal",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Assembly",
"sub_subtype": "assembly",
"subtype": "installation",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Placement",
"sub_subtype": "placement",
"subtype": "installation",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Installation",
"sub_subtype": "installation",
"subtype": "installation",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Check (destination)",
"sub_subtype": "destination_condition_check",
"subtype": "condition",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Check (origin)",
"sub_subtype": "origin_condition_check",
"subtype": "condition",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Report (destination)",
"sub_subtype": "destination_full_condition_report",
"subtype": "condition",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Report (origin)",
"sub_subtype": "origin_full_condition_report",
"subtype": "condition",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
{
"name": "Unpacking Soft Materials (destination)",
"sub_subtype": "destination_unpacking_soft",
"subtype": "unpacking",
"type": "handling"
}
],
"name": "Unpacking (destination)",
"sub_subtype": "destination_unpacking",
"subtype": "unpacking",
"type": "handling"
}
],
"quote_type": "premium",
"status": "published",
"total": "2",
"total_currency": "USD"
},
{
"id": 62,
"included_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
{
"name": "Soft Packed Disposal",
"sub_subtype": "soft_packed_disposal",
"subtype": "debris_disposal",
"type": "handling"
}
],
"is_requested": false,
"is_required": true,
"name": "Debris Disposal",
"sub_subtype": "debris_disposal",
"subtype": "debris_disposal",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Fuel Surcharge",
"sub_subtype": "fuel_surcharge",
"subtype": "fees",
"type": "taxes_duties_fees"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Strongbox",
"sub_subtype": "strongbox",
"subtype": "packing_materials",
"type": "packing"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Consolidated Trucking",
"sub_subtype": "road_groupage",
"subtype": "consolidated",
"type": "transport"
}
],
"included_insurance_policy": null,
"optional_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
{
"name": "Unpacking Soft Materials (destination)",
"sub_subtype": "destination_unpacking_soft",
"subtype": "unpacking",
"type": "handling"
}
],
"name": "Unpacking (destination)",
"sub_subtype": "destination_unpacking",
"subtype": "unpacking",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Check (destination)",
"sub_subtype": "destination_condition_check",
"subtype": "condition",
"type": "handling"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"name": "Condition Check (origin)",
"sub_subtype": "origin_condition_check",
"subtype": "condition",
"type": "handling"
}
],
"quote_type": "select",
"status": "published",
"total": "4",
"total_currency": "USD"
},
{
"id": 63,
"included_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Fuel Surcharge",
"sub_subtype": "fuel_surcharge",
"subtype": "fees",
"type": "taxes_duties_fees"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Collection",
"sub_subtype": "collection",
"subtype": "collection",
"type": "location"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Ply Box",
"sub_subtype": "ply_box",
"subtype": "packing_materials",
"type": "packing"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "UPS Ground",
"sub_subtype": "parcel",
"subtype": "parcel",
"type": "transport"
}
],
"included_insurance_policy": null,
"optional_services": [
],
"quote_type": "parcel",
"status": "published",
"total": "4",
"total_currency": "USD"
},
{
"id": 64,
"included_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Fuel Surcharge",
"sub_subtype": "fuel_surcharge",
"subtype": "fees",
"type": "taxes_duties_fees"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Collection",
"sub_subtype": "collection",
"subtype": "collection",
"type": "location"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Ply Box",
"sub_subtype": "ply_box",
"subtype": "packing_materials",
"type": "packing"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "UPS Second Day Air",
"sub_subtype": "parcel",
"subtype": "parcel",
"type": "transport"
}
],
"included_insurance_policy": null,
"optional_services": [
],
"quote_type": "parcel",
"status": "published",
"total": "4",
"total_currency": "USD"
},
{
"id": 65,
"included_services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Fuel Surcharge",
"sub_subtype": "fuel_surcharge",
"subtype": "fees",
"type": "taxes_duties_fees"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Collection",
"sub_subtype": "collection",
"subtype": "collection",
"type": "location"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Ply Box",
"sub_subtype": "ply_box",
"subtype": "packing_materials",
"type": "packing"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "UPS Next Day Air",
"sub_subtype": "parcel",
"subtype": "parcel",
"type": "transport"
}
],
"included_insurance_policy": null,
"optional_services": [
],
"quote_type": "parcel",
"status": "published",
"total": "4",
"total_currency": "USD"
}
],
"shipping_notes": null,
"status": "quoted",
"updated_at": "2021-01-21T17:22:10.129653"
}Response example (404)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"errors": {
"detail": "string"
}
}List Shipment records
Retrieve a paginated collection of Shipment records belonging to your Organization
Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
page_size integer
Results per page (max 50)
-
page integer
Page number of the results to fetch.
Responses
-
• 200 object
A collection of Shipment records
-
content-type string
-
x-arta-request-id string
-
items array[]
-
metadata object
-
metadata.page integer(int64)
-
metadata.page_size integer(int64)
-
metadata.total_count integer(int64)
-
-
Definition
GET https://api.shiparta.com/shipmentscURL example
curl \
-X GET https://api.shiparta.com/shipments \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"items": [
{
"created_at": "2021-01-21T21:00:58.403150",
"destination": {
"city": "New York",
"country": "US",
"postal_code": "11249",
"region": "NY"
},
"id": "6b12c76a-5217-4cd6-82d8-7aa5265ebaad",
"internal_reference": null,
"object_count": 1,
"origin": {
"city": "New York",
"country": "US",
"postal_code": "10019",
"region": "NY"
},
"package_count": 1,
"public_reference": null,
"quote_type": "parcel",
"shortcode": "DYL-452144",
"status": "pending",
"total": "4",
"total_currency": "USD",
"updated_at": "2021-01-21T21:00:58.579870"
}
],
"metadata": {
"page": 1,
"page_size": 20,
"total_count": 1
}
}Create a Shipment
After receiving quotes for transport, you can book a shipment on ARTA. This API call requires a Quote ID associated with the quote you intend to book from your initial quote request call.
Additionally, you may optionally provide internal_reference, public_reference, and shipping_notes in the payload of the booking call to add any context relevant to your shipment.
Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
Body
-
shipment object
-
shipment.internal_reference string
This field can be used to pass through any data that you may want returned unaltered for your own later usage
-
shipment.public_reference string
A client defined name for the request. The value provided for the public_reference field may appear in notification emails and shipment detail pages
-
shipment.quote_id Required / number
The numeric ID of the Quote you are booking
-
shipment.shipping_notes string
This field can be used to proivde ARTA any additional context about the shipment
-
Responses
-
• 200 object
response
-
content-type string
-
x-arta-request-id string
-
destination object
-
destination.id string
The location id
-
destination.address_line_1 string
First line of address
-
destination.address_line_2 string
Second line of address
-
destination.address_line_3 string
Third line of address
-
destination.city string
City
-
destination.region string
Political region name, for US states and Canada provinces, use 2 letter abbreviations
-
destination.postal_code string
The postal code
-
destination.country string
The ISO 3166-1 alpha-2 country code of the current or last known location if available
-
destination.title string
The title or name of the location
-
destination.access_restrictions array[string]
Id of location restriction type
-
destination.contacts array[object]
An list of contacts at the location
-
destination.contacts.name string
-
destination.contacts.email_address string
-
destination.contacts.phone_number string
-
-
-
id string
-
insurance_policy object
-
insurance_policy.amount string
-
insurance_policy.amount_currency string
The currency of the insurance amount. Formatted as ISO 4217 three-letter alphabetic currency code
-
insurance_policy.id string
-
insurance_policy.insured_value string
-
insurance_policy.insured_value_currency string
The currency of the insurance amount. Formatted as ISO 4217 three-letter alphabetic currency code
-
-
internal_reference string
This field can be used to pass through any character data that you may want returned unaltered for your own later usage
-
object_count number
The count of objects included in the initial request payload
-
origin object
-
origin.id string
The location id
-
origin.address_line_1 string
First line of address
-
origin.address_line_2 string
Second line of address
-
origin.address_line_3 string
Third line of address
-
origin.city string
City
-
origin.region string
Political region name, for US states and Canada provinces, use 2 letter abbreviations
-
origin.postal_code string
The postal code
-
origin.country string
The ISO 3166-1 alpha-2 country code of the current or last known location if available
-
origin.title string
The title or name of the location
-
origin.access_restrictions array[string]
Id of location restriction type
-
origin.contacts array[object]
An list of contacts at the location
-
origin.contacts.name string
-
origin.contacts.email_address string
-
origin.contacts.phone_number string
-
-
-
packages array[object]
-
packages.depth string
-
packages.handle_with_care boolean
-
packages.height string
-
packages.is_sufficiently_packed boolean
-
packages.packing_materials array[string]
The id of a material.
-
packages.unit_of_measurement string
-
packages.weight string
-
packages.weight_unit string
-
packages.width string
-
packages.objects array[object]
-
packages.objects.current_packing array[string]
A list of packing subtype IDs describing how the item is currently packed
-
packages.objects.depth string
The depth of the object
-
packages.objects.details object
-
packages.objects.details.creation_date string
The creation timing for the object
-
packages.objects.details.creator string
The creator of the object
-
packages.objects.details.is_fragile boolean
Set this flag to true is the item is fragile. This may effect packing and handling costs
-
packages.objects.details.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
-
packages.objects.details.materials array[string]
A list of ids the types of materials used
-
packages.objects.details.title string
The object title
-
-
packages.objects.height string
The height of the object
-
packages.objects.images array[string](uri)
A list image urls of the object
-
packages.objects.internal_reference string
This field can be used to pass through any character data that you may want returned unaltered for your own later usage
-
packages.objects.public_reference string
A client defined name for the object. The value provided for public_reference may be presented in notification emails and on shipment detail pages
-
packages.objects.subtype string
The object sub-type id
-
packages.objects.type string
The object type id
-
packages.objects.unit_of_measurement string
Values are
inandcm. -
packages.objects.value string
-
packages.objects.value_currency string
ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint
-
packages.objects.weight string
The weight of the object
-
packages.objects.weight_unit string
Values are
lbandkg. -
packages.objects.width string
The width of the object
-
-
-
public_reference string
A client defined name for the resource. The value provided for the public_reference field may appear in notification emails and public web pages
-
quote_type string
The ID of the quote type associated with this shipment
-
schedule object
-
schedule.delivery_end string
-
schedule.delivery_start string
-
schedule.pickup_end string
-
schedule.pickup_start string
-
-
services array[object]
-
services.amount string
-
services.amount_currency string
-
services.included_services array[]
-
services.is_requested boolean
-
services.is_required boolean
-
services.name string
-
services.sub_subtype string
-
services.subtype string
-
services.type string
-
-
shipping_notes string
-
shortcode string
A brief random identifier for this shipment
-
status string
The status for this shipment
-
total string
-
total_currency string
The currency of the total. Formatted as ISO 4217 three-letter alphabetic currency code
-
tracking array[]
A list of tracking details for the shipment
-
url string(uri)
The URL for this shipment on the ARTA web platform
-
-
• 404 object
Resource Not Found
-
content-type string
-
x-arta-request-id string
-
errors object
-
errors.detail string
-
-
Definition
POST https://api.shiparta.com/shipmentscURL example
curl \
-X POST https://api.shiparta.com/shipments \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
-d '{"shipment":{"internal_reference":"Accession ID: 823","public_reference":"Order #42","quote_id":42,"shipping_notes":"Collector is a new customer from the West LA gallery"}}'Request payload example
# Headers
Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y
# Payload
{
"shipment": {
"internal_reference": "Accession ID: 823",
"public_reference": "Order #42",
"quote_id": 42,
"shipping_notes": "Collector is a new customer from the West LA gallery"
}
}Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"created_at": "2021-01-21T21:00:58.403150",
"destination": {
"access_restrictions": [
],
"address_line_1": "87 Richardson St",
"address_line_2": null,
"address_line_3": null,
"city": "New York",
"contacts": [
{
"email_address": "al@example.com",
"name": "Alfred Barr",
"phone_number": "(222) 222-2222"
}
],
"country": "US",
"postal_code": "11249",
"region": "NY",
"title": "Home"
},
"id": "6b12c76a-5217-4cd6-82d8-7aa5265ebaad",
"insurance_policy": null,
"internal_reference": null,
"object_count": 1,
"origin": {
"access_restrictions": [
],
"address_line_1": "11 W 53rd St",
"address_line_2": null,
"address_line_3": null,
"city": "New York",
"contacts": [
{
"email_address": "mary@example.com",
"name": "Mary Quinn Sullivan",
"phone_number": "(333) 333-3333"
}
],
"country": "US",
"postal_code": "10019",
"region": "NY",
"title": "Warehouse"
},
"package_count": 1,
"packages": [
{
"depth": "6.0",
"handle_with_care": false,
"height": "14.5",
"id": 131,
"is_sufficiently_packed": false,
"objects": [
{
"current_packing": [
],
"depth": "2",
"details": {
"creation_date": null,
"creator": "Robert Irwin",
"is_cites": false,
"is_fragile": false,
"materials": [
],
"title": "All That Jazz"
},
"height": "10.5",
"images": [
],
"internal_reference": null,
"public_reference": null,
"subtype": "painting_unframed",
"type": "art",
"unit_of_measurement": "in",
"value": "1500",
"value_currency": "USD",
"weight": "3.5",
"weight_unit": "lb",
"width": "10"
}
],
"packing_materials": [
"strongbox"
],
"weight": "3.5",
"weight_unit": "lb",
"width": "14.0"
}
],
"public_reference": null,
"quote_type": "parcel",
"schedule": {
"delivery_end": null,
"delivery_start": null,
"pickup_end": null,
"pickup_start": null
},
"services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "UPS Next Day Air",
"sub_subtype": "parcel",
"subtype": "parcel",
"type": "transport"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Strongbox",
"sub_subtype": "strongbox",
"subtype": "packing_materials",
"type": "packing"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Collection",
"sub_subtype": "collection",
"subtype": "collection",
"type": "location"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Fuel Surcharge",
"sub_subtype": "fuel_surcharge",
"subtype": "fees",
"type": "taxes_duties_fees"
}
],
"shipping_notes": null,
"shortcode": "MA-452144",
"status": "pending",
"total": "4",
"total_currency": "USD",
"tracking": [
],
"updated_at": "2021-01-21T21:00:58.579870",
"url": "https://connect.shiparta.com/shipments/6b12c76a-5217-4cd6-82d8-7aa5265egood/5xTRnCvYkdMFdcFFMWUZaCmXz"
}Response example (404)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"errors": {
"detail": "string"
}
}Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
shipment_id Required / string
shipment_id parameter
Responses
-
• 200 object
Successful Shipment get response
-
content-type string
-
x-arta-request-id string
-
destination object
-
destination.id string
The location id
-
destination.address_line_1 string
First line of address
-
destination.address_line_2 string
Second line of address
-
destination.address_line_3 string
Third line of address
-
destination.city string
City
-
destination.region string
Political region name, for US states and Canada provinces, use 2 letter abbreviations
-
destination.postal_code string
The postal code
-
destination.country string
The ISO 3166-1 alpha-2 country code of the current or last known location if available
-
destination.title string
The title or name of the location
-
destination.access_restrictions array[string]
Id of location restriction type
-
destination.contacts array[object]
An list of contacts at the location
-
destination.contacts.name string
-
destination.contacts.email_address string
-
destination.contacts.phone_number string
-
-
-
id string
-
insurance_policy object
-
insurance_policy.amount string
-
insurance_policy.amount_currency string
The currency of the insurance amount. Formatted as ISO 4217 three-letter alphabetic currency code
-
insurance_policy.id string
-
insurance_policy.insured_value string
-
insurance_policy.insured_value_currency string
The currency of the insurance amount. Formatted as ISO 4217 three-letter alphabetic currency code
-
-
internal_reference string
This field can be used to pass through any character data that you may want returned unaltered for your own later usage
-
object_count number
The count of objects included in the initial request payload
-
origin object
-
origin.id string
The location id
-
origin.address_line_1 string
First line of address
-
origin.address_line_2 string
Second line of address
-
origin.address_line_3 string
Third line of address
-
origin.city string
City
-
origin.region string
Political region name, for US states and Canada provinces, use 2 letter abbreviations
-
origin.postal_code string
The postal code
-
origin.country string
The ISO 3166-1 alpha-2 country code of the current or last known location if available
-
origin.title string
The title or name of the location
-
origin.access_restrictions array[string]
Id of location restriction type
-
origin.contacts array[object]
An list of contacts at the location
-
origin.contacts.name string
-
origin.contacts.email_address string
-
origin.contacts.phone_number string
-
-
-
packages array[object]
-
packages.depth string
-
packages.handle_with_care boolean
-
packages.height string
-
packages.is_sufficiently_packed boolean
-
packages.packing_materials array[string]
The id of a material.
-
packages.unit_of_measurement string
-
packages.weight string
-
packages.weight_unit string
-
packages.width string
-
packages.objects array[object]
-
packages.objects.current_packing array[string]
A list of packing subtype IDs describing how the item is currently packed
-
packages.objects.depth string
The depth of the object
-
packages.objects.details object
-
packages.objects.details.creation_date string
The creation timing for the object
-
packages.objects.details.creator string
The creator of the object
-
packages.objects.details.is_fragile boolean
Set this flag to true is the item is fragile. This may effect packing and handling costs
-
packages.objects.details.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
-
packages.objects.details.materials array[string]
A list of ids the types of materials used
-
packages.objects.details.title string
The object title
-
-
packages.objects.height string
The height of the object
-
packages.objects.images array[string](uri)
A list image urls of the object
-
packages.objects.internal_reference string
This field can be used to pass through any character data that you may want returned unaltered for your own later usage
-
packages.objects.public_reference string
A client defined name for the object. The value provided for public_reference may be presented in notification emails and on shipment detail pages
-
packages.objects.subtype string
The object sub-type id
-
packages.objects.type string
The object type id
-
packages.objects.unit_of_measurement string
Values are
inandcm. -
packages.objects.value string
-
packages.objects.value_currency string
ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint
-
packages.objects.weight string
The weight of the object
-
packages.objects.weight_unit string
Values are
lbandkg. -
packages.objects.width string
The width of the object
-
-
-
public_reference string
A client defined name for the resource. The value provided for the public_reference field may appear in notification emails and public web pages
-
quote_type string
The ID of the quote type associated with this shipment
-
schedule object
-
schedule.delivery_end string
-
schedule.delivery_start string
-
schedule.pickup_end string
-
schedule.pickup_start string
-
-
services array[object]
-
services.amount string
-
services.amount_currency string
-
services.included_services array[]
-
services.is_requested boolean
-
services.is_required boolean
-
services.name string
-
services.sub_subtype string
-
services.subtype string
-
services.type string
-
-
shipping_notes string
-
shortcode string
A brief random identifier for this shipment
-
status string
The status for this shipment
-
total string
-
total_currency string
The currency of the total. Formatted as ISO 4217 three-letter alphabetic currency code
-
tracking array[]
A list of tracking details for the shipment
-
url string(uri)
The URL for this shipment on the ARTA web platform
-
-
• 404 object
Resource Not Found
-
content-type string
-
x-arta-request-id string
-
errors object
-
errors.detail string
-
-
Definition
GET https://api.shiparta.com/shipments/{shipment_id}cURL example
curl \
-X GET https://api.shiparta.com/shipments/{shipment_id} \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"created_at": "2021-01-21T21:00:58.403150",
"destination": {
"access_restrictions": [
],
"address_line_1": "87 Richardson St",
"address_line_2": null,
"address_line_3": null,
"city": "New York",
"contacts": [
{
"email_address": "al@example.com",
"name": "Alfred Barr",
"phone_number": "(222) 222-2222"
}
],
"country": "US",
"postal_code": "11249",
"region": "NY",
"title": "Home"
},
"id": "6b12c76a-5217-4cd6-82d8-7aa5265ebaad",
"insurance_policy": null,
"internal_reference": null,
"object_count": 1,
"origin": {
"access_restrictions": [
],
"address_line_1": "11 W 53rd St",
"address_line_2": null,
"address_line_3": null,
"city": "New York",
"contacts": [
{
"email_address": "mary@example.com",
"name": "Mary Quinn Sullivan",
"phone_number": "(333) 333-3333"
}
],
"country": "US",
"postal_code": "10019",
"region": "NY",
"title": "Warehouse"
},
"package_count": 1,
"packages": [
{
"depth": "6.0",
"handle_with_care": false,
"height": "14.5",
"id": 131,
"is_sufficiently_packed": false,
"objects": [
{
"current_packing": [
],
"depth": "2",
"details": {
"creation_date": null,
"creator": "Robert Irwin",
"is_cites": false,
"is_fragile": false,
"materials": [
],
"title": "All That Jazz"
},
"height": "10.5",
"images": [
],
"internal_reference": null,
"public_reference": null,
"subtype": "painting_unframed",
"type": "art",
"unit_of_measurement": "in",
"value": "1500",
"value_currency": "USD",
"weight": "3.5",
"weight_unit": "lb",
"width": "10"
}
],
"packing_materials": [
"strongbox"
],
"weight": "3.5",
"weight_unit": "lb",
"width": "14.0"
}
],
"public_reference": null,
"quote_type": "parcel",
"schedule": {
"delivery_end": null,
"delivery_start": null,
"pickup_end": null,
"pickup_start": null
},
"services": [
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "UPS Next Day Air",
"sub_subtype": "parcel",
"subtype": "parcel",
"type": "transport"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Strongbox",
"sub_subtype": "strongbox",
"subtype": "packing_materials",
"type": "packing"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Collection",
"sub_subtype": "collection",
"subtype": "collection",
"type": "location"
},
{
"amount": "1",
"amount_currency": "USD",
"included_services": [
],
"is_requested": false,
"is_required": true,
"name": "Fuel Surcharge",
"sub_subtype": "fuel_surcharge",
"subtype": "fees",
"type": "taxes_duties_fees"
}
],
"shipping_notes": null,
"shortcode": "MA-452144",
"status": "pending",
"total": "4",
"total_currency": "USD",
"tracking": [
],
"updated_at": "2021-01-21T21:00:58.579870",
"url": "https://connect.shiparta.com/shipments/6b12c76a-5217-4cd6-82d8-7aa5265egood/5xTRnCvYkdMFdcFFMWUZaCmXz"
}Response example (404)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"errors": {
"detail": "string"
}
}Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
tracking_number Required / string
tracking_number parameter
Responses
-
• 200 object
Successful Tracking response
-
content-type string
-
x-arta-request-id string
-
carrier object
-
carrier.code string
-
carrier.name string
-
carrier.phone_number string
-
carrier.url string
-
-
events array[object]
-
events.code string
-
events.name string
-
events.phone_number string
-
events.url string
-
-
status string
-
tracking_number string
-
-
• 404 object
Resource Not Found
-
content-type string
-
x-arta-request-id string
-
errors object
-
errors.detail string
-
-
Definition
GET https://api.shiparta.com/trackings/{tracking_number}cURL example
curl \
-X GET https://api.shiparta.com/trackings/{tracking_number} \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"carrier": {
"code": "ups",
"name": "UPS",
"phone_number": "+1 800-742-5877",
"url": "https://www.ups.com/us/en/Home.page"
},
"events": [
{
"date": "2020-10-20 13:53",
"location": "BROOKLYN,NY,11249,US",
"summary": "DELIVERED"
},
{
"date": "2020-10-20 08:58",
"location": "Maspeth,NY,US",
"summary": "Out For Delivery Today"
},
{
"date": "2020-10-20 05:23",
"location": "Maspeth,NY,US",
"summary": "Loaded on Delivery Vehicle"
},
{
"date": "2020-10-20 05:02",
"location": "Maspeth,NY,US",
"summary": "Destination Scan"
},
{
"date": "2020-10-20 04:08",
"location": "Maspeth,NY,US",
"summary": "Arrived at Facility"
},
{
"date": "2020-10-20 03:11",
"location": "Saddle Brook,NJ,US",
"summary": "Departed from Facility"
},
{
"date": "2020-10-20 00:42",
"location": "Saddle Brook,NJ,US",
"summary": "Arrived at Facility"
},
{
"date": "2020-10-19 21:17",
"location": "Carlisle,PA,US",
"summary": "Departed from Facility"
},
{
"date": "2020-10-19 18:04",
"location": "Carlisle,PA,US",
"summary": "Origin Scan"
},
{
"date": "2020-10-19 10:34",
"location": "US",
"summary": "Order Processed: Ready for UPS"
}
],
"status": "DELIVERED",
"tracking_number": "1Z06************"
}Response example (404)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"errors": {
"detail": "string"
}
}Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
page_size integer
Results per page (max 50)
-
page integer
Page number of the results to fetch.
Responses
-
• 200 object
A collection of Webhooks
-
content-type string
-
x-arta-request-id string
-
items array[object]
-
items.id integer(int64)
-
items.created_at string
-
items.name string
-
items.updated_at string
-
items.url string
-
-
metadata object
-
metadata.page integer(int64)
-
metadata.page_size integer(int64)
-
metadata.total_count integer(int64)
-
-
Definition
GET https://api.shiparta.com/webhookscURL example
curl \
-X GET https://api.shiparta.com/webhooks \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"items": [
{
"id": 4,
"created_at": "2020-10-22T21:12:48.839165",
"name": "Notifications Endpoint",
"updated_at": "2020-10-22T21:12:48.839165",
"url": "https://notifications.example.com/hooks/"
}
],
"metadata": {
"page": 1,
"page_size": 20,
"total_count": 1
}
}Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
Body
-
webhook object
-
webhook.name string
The name for this Webhook.
-
webhook.url string
The URL for this Webhook.
-
Responses
-
• 201 object
response
-
content-type string
-
x-arta-request-id string
-
id integer(int64)
-
created_at string
-
name string
-
updated_at string
-
url string
-
-
• 400 object
Bad Request
-
errors object
-
errors.detail string
-
-
Definition
POST https://api.shiparta.com/webhookscURL example
curl \
-X POST https://api.shiparta.com/webhooks \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
-d '{"webhook":{"name":"Production webhooks endpoint","url":"https://notifications.example.com/"}}'Request payload example
# Headers
Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y
# Payload
{
"webhook": {
"name": "Production webhooks endpoint",
"url": "https://notifications.example.com/"
}
}Response example (201)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"id": 4,
"created_at": "2020-10-22T21:12:48.839165",
"name": "Notifications Endpoint",
"updated_at": "2020-10-22T21:12:48.839165",
"url": "https://notifications.example.com/hooks/"
}Response example (400)
{
"errors": {
"detail": "string"
}
}Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
webhook_id Required / integer
webhook_id parameter
Responses
-
• 200 object
Successful Webhook response
-
content-type string
-
x-arta-request-id string
-
id integer(int64)
-
created_at string
-
name string
-
updated_at string
-
url string
-
-
• 404 object
Resource Not Found
-
content-type string
-
x-arta-request-id string
-
errors object
-
errors.detail string
-
-
Definition
GET https://api.shiparta.com/webhooks/{webhook_id}cURL example
curl \
-X GET https://api.shiparta.com/webhooks/{webhook_id} \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"id": 4,
"created_at": "2020-10-22T21:12:48.839165",
"name": "Notifications Endpoint",
"updated_at": "2020-10-22T21:12:48.839165",
"url": "https://notifications.example.com/hooks/"
}Response example (404)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"errors": {
"detail": "string"
}
}Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
webhook_id Required / integer
webhook_id parameter
Responses
-
• 204
An empty response from the ARTA API
-
content-type string
-
x-arta-request-id string
-
-
• 404 object
Resource Not Found
-
content-type string
-
x-arta-request-id string
-
errors object
-
errors.detail string
-
-
Definition
DELETE https://api.shiparta.com/webhooks/{webhook_id}cURL example
curl \
-X DELETE https://api.shiparta.com/webhooks/{webhook_id} \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (204)
# Headers
content-type: string
x-arta-request-id: stringResponse example (404)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"errors": {
"detail": "string"
}
}Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
webhook_id Required / integer
webhook_id parameter
Body
-
webhook object
-
webhook.name string
The name for this Webhook.
-
webhook.url string
The URL for this Webhook.
-
Responses
-
• 200 object
Successful Webhook response
-
content-type string
-
x-arta-request-id string
-
id integer(int64)
-
created_at string
-
name string
-
updated_at string
-
url string
-
-
• 404 object
Resource Not Found
-
content-type string
-
x-arta-request-id string
-
errors object
-
errors.detail string
-
-
Definition
PATCH https://api.shiparta.com/webhooks/{webhook_id}cURL example
curl \
-X PATCH https://api.shiparta.com/webhooks/{webhook_id} \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
-d '{"webhook":{"name":"hello@shiparta.com","url":"Arta"}}'Request payload example
# Headers
Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y
# Payload
{
"webhook": {
"name": "hello@shiparta.com",
"url": "Arta"
}
}Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"id": 4,
"created_at": "2020-10-22T21:12:48.839165",
"name": "Notifications Endpoint",
"updated_at": "2020-10-22T21:12:48.839165",
"url": "https://notifications.example.com/hooks/"
}Response example (404)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"errors": {
"detail": "string"
}
}Headers
-
Authorization Required / string
Authorize your API calls with an ARTA API token
URL parameters
-
webhook_id Required / integer
webhook_id parameter
Responses
-
• 200 object
Successful Webhook response
-
content-type string
-
x-arta-request-id string
-
id integer(int64)
-
created_at string
-
name string
-
updated_at string
-
url string
-
-
• 404 object
Resource Not Found
-
content-type string
-
x-arta-request-id string
-
errors object
-
errors.detail string
-
-
Definition
POST https://api.shiparta.com/webhooks/{webhook_id}/pingcURL example
curl \
-X POST https://api.shiparta.com/webhooks/{webhook_id}/ping \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"Response example (200)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"id": 4,
"created_at": "2020-10-22T21:12:48.839165",
"name": "Notifications Endpoint",
"updated_at": "2020-10-22T21:12:48.839165",
"url": "https://notifications.example.com/hooks/"
}Response example (404)
# Headers
content-type: string
x-arta-request-id: string
# Payload
{
"errors": {
"detail": "string"
}
}