ARTA Public API

The ARTA Public API provides quote generation, transport booking, and tracking capabilities. Additionally the API enables ARTA partner organizations to configure email and webhook notifications for their accounts.

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

Base URL
https://api.shiparta.com

Authentication

The 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"

Api keys

List API Keys

Retrieve a paginated collection of API Keys belonging to your Organization

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Query parameters
  • page_size integer

    Results per page (max 50)

    Default value is 20.

  • page integer

    Page number of the results to fetch.

    Default value is 1.

Responses
  • • 200 object

    A succesful collection of API Keys associated with your organization

    • content-type string
    • x-arta-request-id string
    • items array[object]
      • id integer(int64)
      • created_at string
      • is_testing boolean
      • token string
      • updated_at string
    • metadata object
      • page integer(int64)
      • page_size integer(int64)
      • total_count integer(int64)
Definition
GET https://api.shiparta.com/api_keys
cURL example
curl \ -X GET https://api.shiparta.com/api_keys \ -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
    • 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
      • detail string
Definition
POST https://api.shiparta.com/api_keys
cURL 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" } }

Get an API Key

Get an API Key

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Path 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
      • 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 "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" } }

Delete an API Key

Delete an API Key belonging to your Organization

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Path 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
      • 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 "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response example (204)
# Headers content-type: string x-arta-request-id: string
Response example (404)
# Headers content-type: string x-arta-request-id: string # Payload { "errors": { "detail": "string" } }

Email rules

List Email Rules

Retrieve a paginated collection of Email Rules belonging to your Organization

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Query parameters
  • page_size integer

    Results per page (max 50)

    Default value is 20.

  • page integer

    Page number of the results to fetch.

    Default value is 1.

Responses
  • • 200 object

    A collection of Email Rules

    • content-type string
    • x-arta-request-id string
    • items array[object]
      • email_notification_id string
      • id integer(int64)
      • created_at string
      • recipients array[string]
      • updated_at string
    • metadata object
      • page integer(int64)
      • page_size integer(int64)
      • total_count integer(int64)
Definition
GET https://api.shiparta.com/email_rules
cURL example
curl \ -X GET https://api.shiparta.com/email_rules \ -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 } }

Create an Email Rule

response

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Body
  • email_rule object
    • email_notification_id Required / string

      The ID belonging to the Email Notification for this 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
      • detail string
Definition
POST https://api.shiparta.com/email_rules
cURL 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":["destination","origin"]}}'
Request payload example
# Headers Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y # Payload { "email_rule": { "email_notification_id": "booking", "recipients": [ "destination", "origin" ] } }
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" } }

Get an Email Rule

Retrieve an existing Email Rule request

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Path 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
      • 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 "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" } }

Delete an Email Rule

Delete an Email Rule

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Path 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
      • 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 "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response example (204)
# Headers content-type: string x-arta-request-id: string
Response example (404)
# Headers content-type: string x-arta-request-id: string # Payload { "errors": { "detail": "string" } }

Update an Email Rule

Update an existing Email Rule request

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Path parameters
  • email_rule_id Required / integer

    email_rule_id parameter

Body
  • email_rule object
    • 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
      • 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":["destination","origin"]}}'
Request payload example
# Headers Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y # Payload { "email_rule": { "recipients": [ "destination", "origin" ] } }
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" } }

Email subscriptions

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

Query parameters
  • page_size integer

    Results per page (max 50)

    Default value is 20.

  • page integer

    Page number of the results to fetch.

    Default value is 1.

Responses
  • • 200 object

    A collection of Email Subscriptions

    • content-type string
    • x-arta-request-id string
    • items array[object]
      • email_address string
      • email_notification_ids array[string]
      • id integer(int64)
      • created_at string
      • name string
      • updated_at string
    • metadata object
      • page integer(int64)
      • page_size integer(int64)
      • total_count integer(int64)
Definition
GET https://api.shiparta.com/email_subscriptions
cURL example
curl \ -X GET https://api.shiparta.com/email_subscriptions \ -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 } }

Create an Email Subscription

response

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Body
  • email_subscription object
    • email_address string

      The email_address for this Email Subscription.

    • email_notification_ids array[string]

      The list of Email Notification IDs for this 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
      • detail string
Definition
POST https://api.shiparta.com/email_subscriptions
cURL 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":["booking","scheduling"],"name":"Arta"}}'
Request payload example
# Headers Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y # Payload { "email_subscription": { "email_address": "hello@shiparta.com", "email_notification_ids": [ "booking", "scheduling" ], "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" } }

Get an Email Subscription

Retrieve an existing Email Subscription request

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Path 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
      • 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 "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" } }

Delete an Email Subscription

Delete an Email Subscription

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Path 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
      • 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 "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response example (204)
# Headers content-type: string x-arta-request-id: string
Response example (404)
# Headers content-type: string x-arta-request-id: string # Payload { "errors": { "detail": "string" } }

Update an Email Subscription

Update an existing Email Subscription request

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Path parameters
  • email_subscription_id Required / integer

    email_subscription_id parameter

Body
  • email_subscription object
    • 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
      • 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":["destination","origin"]}}'
Request payload example
# Headers Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y # Payload { "email_subscription": { "recipients": [ "destination", "origin" ] } }
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" } }

Invoice payments

List invoice payment records

Retrieve a paginated collection of Invoice Payments belonging to your Organization

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Query parameters
  • page_size integer

    Results per page (max 50)

    Default value is 20.

  • page integer

    Page number of the results to fetch.

    Default value is 1.

Responses
  • • 200 object

    A collection of Log records

    • content-type string
    • x-arta-request-id string
    • items array[object]
      • amount_owed string
      • amount_owed_currency string
      • amount_paid string
      • amount_paid_currency string
      • created_at string
      • invoice_url string
      • id integer
      • issued_on string
      • shipment_id string
      • status string
      • updated_at string
    • metadata object
      • page integer(int64)
      • page_size integer(int64)
      • total_count integer(int64)
Definition
GET https://api.shiparta.com/invoice_payments
cURL example
curl \ -X GET https://api.shiparta.com/invoice_payments \ -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response example (200)
# Headers content-type: string x-arta-request-id: string # Payload { "items": [ { "amount": "502.25", "amount_currency": "USD", "created_at": "2021-02-19T19:09:57.971464", "id": 1, "invoice_id": 11, "payment_id": 1, "shipment_id": "45360593-6c6c-44ab-8a17-0fd198fff058", "updated_at": "2021-02-19T19:09:57.971464" } ], "metadata": { "page": 1, "page_size": 20, "total_count": 1 } }

Get an Invoice Payment record

Retrieve an existing Invoice Payment record

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Path parameters
  • invoice_payment_id Required / integer

    invoice_payment_id parameter

Responses
  • • 200 object

    Successful Invoice Payment response

    • content-type string
    • x-arta-request-id string
    • amount string
    • amount_currency string
    • created_at string
    • id integer
    • invoice_id integer
    • payment_id integer
    • shipment_id string
    • updated_at string
  • • 404 object

    Resource Not Found

    • content-type string
    • x-arta-request-id string
    • errors object
      • detail string
Definition
GET https://api.shiparta.com/invoice_payments/{invoice_payment_id}
cURL example
curl \ -X GET https://api.shiparta.com/invoice_payments/{invoice_payment_id} \ -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response example (200)
# Headers content-type: string x-arta-request-id: string # Payload { "amount": "502.25", "amount_currency": "USD", "created_at": "2021-02-19T19:09:57.971464", "id": 1, "invoice_id": 11, "payment_id": 1, "shipment_id": "45360593-6c6c-44ab-8a17-0fd198fff058", "updated_at": "2021-02-19T19:09:57.971464" }
Response example (404)
# Headers content-type: string x-arta-request-id: string # Payload { "errors": { "detail": "string" } }

Invoices

List invoice records

Retrieve a paginated collection of Invoices belonging to your Organization

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Query parameters
  • page_size integer

    Results per page (max 50)

    Default value is 20.

  • page integer

    Page number of the results to fetch.

    Default value is 1.

Responses
  • • 200 object

    A collection of Log records

    • content-type string
    • x-arta-request-id string
    • items array[object]
      • amount_owed string
      • amount_owed_currency string
      • amount_paid string
      • amount_paid_currency string
      • created_at string
      • invoice_url string
      • id integer
      • issued_on string
      • shipment_id string
      • status string
      • updated_at string
    • metadata object
      • page integer(int64)
      • page_size integer(int64)
      • total_count integer(int64)
Definition
GET https://api.shiparta.com/invoices
cURL example
curl \ -X GET https://api.shiparta.com/invoices \ -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response example (200)
# Headers content-type: string x-arta-request-id: string # Payload { "items": [ { "amount_owed": "276.91", "amount_owed_currency": "USD", "amount_paid": "276.91", "amount_paid_currency": "USD", "created_at": "2021-03-10T20:15:34.096258", "invoice_url": null, "id": 2216, "issued_on": "2021-03-10", "shipment_id": "53d6bdec-1eae-46e2-97c2-3e56b1a1095d", "status": "closed", "updated_at": "2021-03-10T20:16:10.202836" } ], "metadata": { "page": 1, "page_size": 20, "total_count": 1 } }

Get an Invoice record

Retrieve an existing Invoice record

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Path parameters
  • invoice_id Required / integer

    invoice_id parameter

Responses
  • • 200 object

    Successful Invoice response

    • content-type string
    • x-arta-request-id string
    • amount_owed string
    • amount_owed_currency string
    • amount_paid string
    • amount_paid_currency string
    • created_at string
    • invoice_url string
    • id integer
    • issued_on string
    • shipment_id string
    • status string
    • updated_at string
  • • 404 object

    Resource Not Found

    • content-type string
    • x-arta-request-id string
    • errors object
      • detail string
Definition
GET https://api.shiparta.com/invoices/{invoice_id}
cURL example
curl \ -X GET https://api.shiparta.com/invoices/{invoice_id} \ -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response example (200)
# Headers content-type: string x-arta-request-id: string # Payload { "amount_owed": "276.91", "amount_owed_currency": "USD", "amount_paid": "276.91", "amount_paid_currency": "USD", "created_at": "2021-03-10T20:15:34.096258", "invoice_url": null, "id": 2216, "issued_on": "2021-03-10", "shipment_id": "53d6bdec-1eae-46e2-97c2-3e56b1a1095d", "status": "closed", "updated_at": "2021-03-10T20:16:10.202836" }
Response example (404)
# Headers content-type: string x-arta-request-id: string # Payload { "errors": { "detail": "string" } }

Logs

List Log records

Retrieve a paginated collection of Log records belonging to your Organization

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Query parameters
  • page_size integer

    Results per page (max 50)

    Default value is 20.

  • page integer

    Page number of the results to fetch.

    Default value is 1.

Responses
  • • 200 object

    A collection of Log records

    • content-type string
    • x-arta-request-id string
    • items array[object]
      • 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
    • metadata object
      • page integer(int64)
      • page_size integer(int64)
      • total_count integer(int64)
Definition
GET https://api.shiparta.com/logs
cURL example
curl \ -X GET https://api.shiparta.com/logs \ -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 } }

Get a Log record

Retrieve an existing Log record

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Path 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
      • detail string
Definition
GET https://api.shiparta.com/logs/{log_id}
cURL example
curl \ -X GET https://api.shiparta.com/logs/{log_id} \ -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" } }

Metadata

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_versions
cURL example
curl \ -X GET https://api.shiparta.com/metadata/api_versions \ -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" } ]

Currencies

Retrieve the list of currencies supported by ARTA's API

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
    • symbol string

      The symbol used to denote that a number is a monetary value in a particular currency

    • id string

      The ID representing the resource

    • name string

      A brief label for the currency

Definition
GET https://api.shiparta.com/metadata/currencies
cURL example
curl \ -X GET https://api.shiparta.com/metadata/currencies \ -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response example (200)
# Headers content-type: string x-arta-request-id: string # Payload [ { "symbol": "$", "id": "USD", "name": "US Dollar" } ]

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_notifications
cURL example
curl \ -X GET https://api.shiparta.com/metadata/email_notifications \ -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" } ]

Insurance

The list of insurance types supported by ARTA's API.

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/insurances
cURL example
curl \ -X GET https://api.shiparta.com/metadata/insurances \ -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_restrictions
cURL example
curl \ -X GET https://api.shiparta.com/metadata/location_access_restrictions \ -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" } ]

Object Types

The list of object types supported by ARTA's API.

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

      • 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/objects
cURL example
curl \ -X GET https://api.shiparta.com/metadata/objects \ -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)" } ] } ]

Parcel Transport Services

The list of parcel transport services and their descriptions. The id and name fields are present in ARTA Parcel quote request and shipment service responses. The description field provides additional context about the differences between each transport service.

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Responses
  • • 200 array[object]

    A collection of Parcel Transport 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

Definition
GET https://api.shiparta.com/metadata/parcel_transport_services
cURL example
curl \ -X GET https://api.shiparta.com/metadata/parcel_transport_services \ -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response example (200)
# Headers content-type: string x-arta-request-id: string # Payload [ { "description": "Delivers the following business day once shipped. Available in the contiguous US and Puerto Rico.", "id": "next_day_air", "name": "Next Day Air" } ]

Object Materials

Retrieve the list of valid object materials

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_materials
cURL example
curl \ -X GET https://api.shiparta.com/metadata/object_materials \ -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" } ]

Packing Types

The list of packing types supported by ARTA's API.

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

      • 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/packings
cURL example
curl \ -X GET https://api.shiparta.com/metadata/packings \ -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" } ] } ]

Quote Types

The list of Quote types provided by ARTA.

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/quotes
cURL example
curl \ -X GET https://api.shiparta.com/metadata/quotes \ -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" } ]

Quote Request Statuses

The list of statuses for a quote request resources.

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_statuses
cURL example
curl \ -X GET https://api.shiparta.com/metadata/request_statuses \ -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" } ]

Services

The list of shipment services supported by ARTA's API.

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

      • description string

        A long form description

      • id string

        The ID representing the resource

      • name string

        A brief title for the resource

      • sub_subtypes array[object]

        The subtypes for this resource

        • description string

          A long form description

        • id string

          The ID representing the resource

        • is_requestable boolean

          Whether this service is requestable by the client

        • name string

          A brief title for the resource

Definition
GET https://api.shiparta.com/metadata/services
cURL example
curl \ -X GET https://api.shiparta.com/metadata/services \ -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" } ] } ] } ]

Shipment Statuses

The list of statuses for a shipment on ARTA.

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_statuses
cURL example
curl \ -X GET https://api.shiparta.com/metadata/shipment_statuses \ -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" } ]

Organization

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
      • detail string
Definition
GET https://api.shiparta.com/organization
cURL example
curl \ -X GET https://api.shiparta.com/organization \ -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
    • 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-Version header

    • 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
      • detail string
Definition
PATCH https://api.shiparta.com/organization
cURL 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" } }

Payments

List payment records

Retrieve a paginated collection of Payments belonging to your Organization

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Query parameters
  • page_size integer

    Results per page (max 50)

    Default value is 20.

  • page integer

    Page number of the results to fetch.

    Default value is 1.

Responses
  • • 200 object

    A collection of Log records

    • content-type string
    • x-arta-request-id string
    • items array[object]
      • amount_owed string
      • amount_owed_currency string
      • amount_paid string
      • amount_paid_currency string
      • created_at string
      • invoice_url string
      • id integer
      • issued_on string
      • shipment_id string
      • status string
      • updated_at string
    • metadata object
      • page integer(int64)
      • page_size integer(int64)
      • total_count integer(int64)
Definition
GET https://api.shiparta.com/payments
cURL example
curl \ -X GET https://api.shiparta.com/payments \ -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response example (200)
# Headers content-type: string x-arta-request-id: string # Payload { "items": [ { "amount": "502.25", "amount_currency": "USD", "context": "hosted_checkout", "created_at": "2021-02-19T19:09:57.954437", "id": 1, "paid_on": "2021-02-19", "updated_at": "2021-02-19T19:09:57.954437" } ], "metadata": { "page": 1, "page_size": 20, "total_count": 1 } }

Get an Payment record

Retrieve an existing Payment record

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Path parameters
  • payment_id Required / integer

    payment_id parameter

Responses
  • • 200 object

    Successful Payment response

    • content-type string
    • x-arta-request-id string
    • amount string
    • amount_currency string
    • created_at string
    • context string
    • id integer
    • paid_on string
    • updated_at string
  • • 404 object

    Resource Not Found

    • content-type string
    • x-arta-request-id string
    • errors object
      • detail string
Definition
GET https://api.shiparta.com/payments/{payment_id}
cURL example
curl \ -X GET https://api.shiparta.com/payments/{payment_id} \ -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response example (200)
# Headers content-type: string x-arta-request-id: string # Payload { "amount": "502.25", "amount_currency": "USD", "context": "hosted_checkout", "created_at": "2021-02-19T19:09:57.954437", "id": 1, "paid_on": "2021-02-19", "updated_at": "2021-02-19T19:09:57.954437" }
Response example (404)
# Headers content-type: string x-arta-request-id: string # Payload { "errors": { "detail": "string" } }

Requests

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

Query parameters
  • page_size integer

    Results per page (max 50)

    Default value is 20.

  • page integer

    Page number of the results to fetch.

    Default value is 1.

Responses
  • • 200 object

    A collection of Quote Request records

    • content-type string
    • x-arta-request-id string
    • items array[]
    • metadata object
      • page integer(int64)
      • page_size integer(int64)
      • total_count integer(int64)
Definition
GET https://api.shiparta.com/requests
cURL example
curl \ -X GET https://api.shiparta.com/requests \ -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" ], "shortcode": "DEMO-R29NAW", "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
    • additional_services array[string]

      The id of a service.

    • 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

      Default value is USD.

    • destination Required / object

      The destination location for the shipment quote request

      • 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

      • address_line_1 string

        The first line of the location's street address

      • address_line_2 string

        The second line of the location's street address

      • address_line_3 string

        The third line of the location's street address

      • city string

        The name of the city for the location

      • region string

        Political region name, for US states and Canada provinces, use 2 letter abbreviations

      • postal_code Required / string

        The postal code for the location

      • country Required / string

        The ISO 3166-1 alpha-2 country code of the location

      • title string

        The name for the location

      • contacts array[object]

        The contact details for the location

        • name Required / string

          The contact's name

        • email_address string

          The email address for this contact

        • phone_number string

          The phone_number for this contact

    • insurance string

      The ID of the requested ARTA insurance type. Options are defined in the Insurances metadata endpoint

    • internal_reference string

      This field can be used to pass through any data that you may want returned unaltered for your own later usage

    • objects array[object]
      • internal_reference string

        This field can be used to pass through any data that you may want returned unaltered for your own later usage

      • current_packing array[string]

        A list of packing subtype IDs describing how the item is currently packed

      • depth Required / string

        The depth of the object

      • details object
        • materials array[string]

          A list of IDs describing the types of materials used

        • creation_date string

          Details about the timing in which an object was created

        • creator string

          The creator of the object

        • notes string

          Any notes about the item

        • title string

          The object title

        • is_fragile boolean

          Set this flag to true is the item is fragile. This may effect packing and handling costs

        • 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

      • height Required / string

        The height of the object

      • images array[string](uri)

        A list image urls of the object

      • 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

      • subtype Required / string

        The object subtype ID. Options are defined in the Object types metadata endpoint

      • width Required / string

        The width of the object

      • unit_of_measurement Required / string

        Values are in and cm.

      • weight string

        The weight of the object

      • weight_unit Required / string

        The unit of the object

        Values are lb and kg.

      • value Required / string
      • value_currency Required / string

        ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

        Default value is USD.

    • origin Required / object

      The originating location for the shipment quote request

      • 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

      • address_line_1 string

        The first line of the location's street address

      • address_line_2 string

        The second line of the location's street address

      • address_line_3 string

        The third line of the location's street address

      • city string

        The name of the city for the location

      • region string

        Political region name, for US states and Canada provinces, use 2 letter abbreviations

      • postal_code Required / string

        The postal code for the location

      • country Required / string

        The ISO 3166-1 alpha-2 country code of the location

      • title string

        The name for the location

      • contacts array[object]

        The contact details for the location

        • name Required / string

          The contact's name

        • email_address string

          The main email address for this contact

        • phone_number string

          The main phone_number for this contact

    • 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

    • 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
      • ready boolean

        Returns true if the quotes in this request may be booked

      • missing array[string]

        A list image urls of fields missing for the request to be bookable

    • currency string

      ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

      Default value is USD.

    • destination object
      • id string

        The location id

      • address_line_1 string

        First line of address

      • address_line_2 string

        Second line of address

      • address_line_3 string

        Third line of address

      • city string

        City

      • region string

        Political region name, for US states and Canada provinces, use 2 letter abbreviations

      • postal_code string

        The postal code

      • country string

        The ISO 3166-1 alpha-2 country code of the current or last known location if available

      • title string

        The title or name of the location

      • access_restrictions array[string]

        Id of location restriction type

      • contacts array[object]

        An list of contacts at the location

        • name string
        • email_address string
        • phone_number string
    • disqualifications array[object]

      The list of reasons for which particular quote types were disqulified

      • quote_types array[string]

        The id of a quote type

      • reason string

        A brief explanation of the disqualification

      • 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

    • log_request_id string

      The request ID for the API call that created the resource. This request ID maps to the Log resource's "request_id" field.

    • object_count number

      The count of objects included in the initial request payload

    • objects array[object]
      • 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

      • depth string

        The depth of the object

      • details object
        • creation_date string

          Details about the timing in which an object was created

        • creator string

          The creator of the object

        • 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

        • is_fragile boolean

          Set this flag to true is the item is fragile. This may effect packing and handling costs

        • materials array[string]

          A list of IDs describing the types of materials used. Options are defined in the Object Materials metadata endpoint

        • notes string

          Any notes about the object

        • title string

          The object title

      • height string

        The height of the object

      • images array[string](uri)

        A list image urls of the object

      • 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

      • public_reference string

        A user defined name of the object

      • subtype string

        The object subtype id

      • type string

        The object type id

      • width string

        The width of the object

      • weight string

        The height of the object

      • unit_of_measurement string

        Values are in and cm.

      • value string
      • value_currency string

        ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

        Default value is USD.

    • origin object
      • id string

        The location id

      • address_line_1 string

        First line of address

      • address_line_2 string

        Second line of address

      • address_line_3 string

        Third line of address

      • city string

        City

      • region string

        Political region name, for US states and Canada provinces, use 2 letter abbreviations

      • postal_code string

        The postal code

      • country string

        The ISO 3166-1 alpha-2 country code of the current or last known location if available

      • title string

        The title or name of the location

      • access_restrictions array[string]

        Id of location restriction type

      • contacts array[object]

        An list of contacts at the location

        • name string
        • email_address string
        • 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[object]

      The list of quotes returned for the request

      • id integer
      • included_insurance_policy object
        • amount string
        • amount_currency string

          ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

          Default value is USD.

        • id string
        • insured_value string
        • insured_value_currency string

          ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

          Default value is USD.

      • included_services array[object]
        • amount string
        • amount_currency string

          ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

          Default value is USD.

        • included_services array[object]
          • name string
          • sub_subtype string
          • subtype string
          • type string
        • is_requested boolean
        • is_required boolean
        • name string
        • sub_subtype string
        • subtype string
        • type string
      • optional_services array[object]
        • amount string
        • amount_currency string

          ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

          Default value is USD.

        • included_services array[object]
          • name string
          • sub_subtype string
          • subtype string
          • type string
        • name string
        • sub_subtype string
        • subtype string
        • type string
      • quote_type string
      • status string
      • total string
      • total_currency string

        ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

        Default value is USD.

    • 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

    • shortcode string

      A brief and unique string identifier for the request resource

    • status string
  • • 400 object

    Bad Request

    • errors object
      • detail string
Definition
POST https://api.shiparta.com/requests
cURL 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", "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, "shortcode": "DEMO-R29NAW", "status": "quoted", "updated_at": "2021-01-21T17:22:10.129653" }
Response example (400)
{ "errors": { "detail": "string" } }

Get a Quote Request

Retrieve an existing Shipment Quote Request record by its ID

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Path 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
      • ready boolean

        Returns true if the quotes in this request may be booked

      • missing array[string]

        A list image urls of fields missing for the request to be bookable

    • currency string

      ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

      Default value is USD.

    • destination object
      • id string

        The location id

      • address_line_1 string

        First line of address

      • address_line_2 string

        Second line of address

      • address_line_3 string

        Third line of address

      • city string

        City

      • region string

        Political region name, for US states and Canada provinces, use 2 letter abbreviations

      • postal_code string

        The postal code

      • country string

        The ISO 3166-1 alpha-2 country code of the current or last known location if available

      • title string

        The title or name of the location

      • access_restrictions array[string]

        Id of location restriction type

      • contacts array[object]

        An list of contacts at the location

        • name string
        • email_address string
        • phone_number string
    • disqualifications array[object]

      The list of reasons for which particular quote types were disqulified

      • quote_types array[string]

        The id of a quote type

      • reason string

        A brief explanation of the disqualification

      • 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

    • log_request_id string

      The request ID for the API call that created the resource. This request ID maps to the Log resource's "request_id" field.

    • object_count number

      The count of objects included in the initial request payload

    • objects array[object]
      • 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

      • depth string

        The depth of the object

      • details object
        • creation_date string

          Details about the timing in which an object was created

        • creator string

          The creator of the object

        • 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

        • is_fragile boolean

          Set this flag to true is the item is fragile. This may effect packing and handling costs

        • materials array[string]

          A list of IDs describing the types of materials used. Options are defined in the Object Materials metadata endpoint

        • notes string

          Any notes about the object

        • title string

          The object title

      • height string

        The height of the object

      • images array[string](uri)

        A list image urls of the object

      • 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

      • public_reference string

        A user defined name of the object

      • subtype string

        The object subtype id

      • type string

        The object type id

      • width string

        The width of the object

      • weight string

        The height of the object

      • unit_of_measurement string

        Values are in and cm.

      • value string
      • value_currency string

        ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

        Default value is USD.

    • origin object
      • id string

        The location id

      • address_line_1 string

        First line of address

      • address_line_2 string

        Second line of address

      • address_line_3 string

        Third line of address

      • city string

        City

      • region string

        Political region name, for US states and Canada provinces, use 2 letter abbreviations

      • postal_code string

        The postal code

      • country string

        The ISO 3166-1 alpha-2 country code of the current or last known location if available

      • title string

        The title or name of the location

      • access_restrictions array[string]

        Id of location restriction type

      • contacts array[object]

        An list of contacts at the location

        • name string
        • email_address string
        • 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[object]

      The list of quotes returned for the request

      • id integer
      • included_insurance_policy object
        • amount string
        • amount_currency string

          ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

          Default value is USD.

        • id string
        • insured_value string
        • insured_value_currency string

          ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

          Default value is USD.

      • included_services array[object]
        • amount string
        • amount_currency string

          ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

          Default value is USD.

        • included_services array[object]
          • name string
          • sub_subtype string
          • subtype string
          • type string
        • is_requested boolean
        • is_required boolean
        • name string
        • sub_subtype string
        • subtype string
        • type string
      • optional_services array[object]
        • amount string
        • amount_currency string

          ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

          Default value is USD.

        • included_services array[object]
          • name string
          • sub_subtype string
          • subtype string
          • type string
        • name string
        • sub_subtype string
        • subtype string
        • type string
      • quote_type string
      • status string
      • total string
      • total_currency string

        ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

        Default value is USD.

    • 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

    • shortcode string

      A brief and unique string identifier for the request resource

    • status string
  • • 404 object

    Resource Not Found

    • content-type string
    • x-arta-request-id string
    • errors object
      • detail string
Definition
GET https://api.shiparta.com/requests/{request_id}
cURL example
curl \ -X GET https://api.shiparta.com/requests/{request_id} \ -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, "shortcode": "DEMO-R29NAW", "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" } }

Update the contacts for a Quote Request

Update the contacts associated with either or both of the quote request's origin and destination locations.

Completing the missing contact details for a previously unbookable quote request will change the bookable status for the request if all other requirements are met.

This endpoint payload requires at least one of a destination or an origin object to be present.

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Path parameters
  • request_id Required / string

    request_id parameter

Body
  • destination object
    • contacts array[object]
      • email_address string

        The email address for this contact

      • name Required / string

        The contact's name

      • phone_number string

        The phone number for this contact

  • origin object
    • contacts array[object]
      • email_address string

        The email address for this contact

      • name Required / string

        The contact's name

      • phone_number string

        The phone number for this contact

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
      • ready boolean

        Returns true if the quotes in this request may be booked

      • missing array[string]

        A list image urls of fields missing for the request to be bookable

    • currency string

      ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

      Default value is USD.

    • destination object
      • id string

        The location id

      • address_line_1 string

        First line of address

      • address_line_2 string

        Second line of address

      • address_line_3 string

        Third line of address

      • city string

        City

      • region string

        Political region name, for US states and Canada provinces, use 2 letter abbreviations

      • postal_code string

        The postal code

      • country string

        The ISO 3166-1 alpha-2 country code of the current or last known location if available

      • title string

        The title or name of the location

      • access_restrictions array[string]

        Id of location restriction type

      • contacts array[object]

        An list of contacts at the location

        • name string
        • email_address string
        • phone_number string
    • disqualifications array[object]

      The list of reasons for which particular quote types were disqulified

      • quote_types array[string]

        The id of a quote type

      • reason string

        A brief explanation of the disqualification

      • 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

    • log_request_id string

      The request ID for the API call that created the resource. This request ID maps to the Log resource's "request_id" field.

    • object_count number

      The count of objects included in the initial request payload

    • objects array[object]
      • 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

      • depth string

        The depth of the object

      • details object
        • creation_date string

          Details about the timing in which an object was created

        • creator string

          The creator of the object

        • 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

        • is_fragile boolean

          Set this flag to true is the item is fragile. This may effect packing and handling costs

        • materials array[string]

          A list of IDs describing the types of materials used. Options are defined in the Object Materials metadata endpoint

        • notes string

          Any notes about the object

        • title string

          The object title

      • height string

        The height of the object

      • images array[string](uri)

        A list image urls of the object

      • 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

      • public_reference string

        A user defined name of the object

      • subtype string

        The object subtype id

      • type string

        The object type id

      • width string

        The width of the object

      • weight string

        The height of the object

      • unit_of_measurement string

        Values are in and cm.

      • value string
      • value_currency string

        ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

        Default value is USD.

    • origin object
      • id string

        The location id

      • address_line_1 string

        First line of address

      • address_line_2 string

        Second line of address

      • address_line_3 string

        Third line of address

      • city string

        City

      • region string

        Political region name, for US states and Canada provinces, use 2 letter abbreviations

      • postal_code string

        The postal code

      • country string

        The ISO 3166-1 alpha-2 country code of the current or last known location if available

      • title string

        The title or name of the location

      • access_restrictions array[string]

        Id of location restriction type

      • contacts array[object]

        An list of contacts at the location

        • name string
        • email_address string
        • 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[object]

      The list of quotes returned for the request

      • id integer
      • included_insurance_policy object
        • amount string
        • amount_currency string

          ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

          Default value is USD.

        • id string
        • insured_value string
        • insured_value_currency string

          ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

          Default value is USD.

      • included_services array[object]
        • amount string
        • amount_currency string

          ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

          Default value is USD.

        • included_services array[object]
          • name string
          • sub_subtype string
          • subtype string
          • type string
        • is_requested boolean
        • is_required boolean
        • name string
        • sub_subtype string
        • subtype string
        • type string
      • optional_services array[object]
        • amount string
        • amount_currency string

          ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

          Default value is USD.

        • included_services array[object]
          • name string
          • sub_subtype string
          • subtype string
          • type string
        • name string
        • sub_subtype string
        • subtype string
        • type string
      • quote_type string
      • status string
      • total string
      • total_currency string

        ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

        Default value is USD.

    • 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

    • shortcode string

      A brief and unique string identifier for the request resource

    • status string
  • • 404 object

    Resource Not Found

    • content-type string
    • x-arta-request-id string
    • errors object
      • detail string
Definition
PATCH https://api.shiparta.com/requests/{request_id}/contacts
cURL example
curl \ -X PATCH https://api.shiparta.com/requests/{request_id}/contacts \ -H "Content-Type: application/json" \ -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \ -d '{"destination":{"contacts":[{"email_address":"destination@example.com","name":"Destination Contact","phone_number":"(310) 123-4567"}]},"origin":{"contacts":[{"email_address":"origin@example.com","name":"Origin Contact","phone_number":"(310) 234-5678"}]}}'
Request payload example
# Headers Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y # Payload { "destination": { "contacts": [ { "email_address": "destination@example.com", "name": "Destination Contact", "phone_number": "(310) 123-4567" } ] }, "origin": { "contacts": [ { "email_address": "origin@example.com", "name": "Origin Contact", "phone_number": "(310) 234-5678" } ] } }
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, "shortcode": "DEMO-R29NAW", "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" } }

Shipments

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

Query parameters
  • page_size integer

    Results per page (max 50)

    Default value is 20.

  • page integer

    Page number of the results to fetch.

    Default value is 1.

Responses
  • • 200 object

    A collection of Shipment records

    • content-type string
    • x-arta-request-id string
    • items array[]
    • metadata object
      • page integer(int64)
      • page_size integer(int64)
      • total_count integer(int64)
Definition
GET https://api.shiparta.com/shipments
cURL example
curl \ -X GET https://api.shiparta.com/shipments \ -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
    • internal_reference string

      This field can be used to pass through any data that you may want returned unaltered for your own later usage

    • 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

    • quote_id Required / number

      The numeric ID of the Quote you are booking

    • 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
      • id string

        The location id

      • address_line_1 string

        First line of address

      • address_line_2 string

        Second line of address

      • address_line_3 string

        Third line of address

      • city string

        City

      • region string

        Political region name, for US states and Canada provinces, use 2 letter abbreviations

      • postal_code string

        The postal code

      • country string

        The ISO 3166-1 alpha-2 country code of the current or last known location if available

      • title string

        The title or name of the location

      • access_restrictions array[string]

        Id of location restriction type

      • contacts array[object]

        An list of contacts at the location

        • name string
        • email_address string
        • phone_number string
    • id string
    • insurance_policy object
      • amount string
      • amount_currency string

        The currency of the insurance amount. Formatted as ISO 4217 three-letter alphabetic currency code

        Default value is USD.

      • id string
      • insured_value string
      • insured_value_currency string

        The currency of the insurance amount. Formatted as ISO 4217 three-letter alphabetic currency code

        Default value is USD.

    • 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
      • id string

        The location id

      • address_line_1 string

        First line of address

      • address_line_2 string

        Second line of address

      • address_line_3 string

        Third line of address

      • city string

        City

      • region string

        Political region name, for US states and Canada provinces, use 2 letter abbreviations

      • postal_code string

        The postal code

      • country string

        The ISO 3166-1 alpha-2 country code of the current or last known location if available

      • title string

        The title or name of the location

      • access_restrictions array[string]

        Id of location restriction type

      • contacts array[object]

        An list of contacts at the location

        • name string
        • email_address string
        • phone_number string
    • packages array[object]
      • depth string
      • handle_with_care boolean
      • height string
      • is_sufficiently_packed boolean
      • packing_materials array[string]

        The id of a material.

      • unit_of_measurement string
      • weight string
      • weight_unit string
      • width string
      • objects array[object]
        • current_packing array[string]

          A list of packing subtype IDs describing how the item is currently packed

        • depth string

          The depth of the object

        • details object
          • creation_date string

            The creation timing for the object

          • creator string

            The creator of the object

          • is_fragile boolean

            Set this flag to true is the item is fragile. This may effect packing and handling costs

          • 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

          • materials array[string]

            A list of ids the types of materials used

          • title string

            The object title

        • height string

          The height of the object

        • images array[string](uri)

          A list image urls of the object

        • 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

        • 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

        • subtype string

          The object sub-type id

        • type string

          The object type id

        • unit_of_measurement string

          Values are in and cm.

        • value string
        • value_currency string

          ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

          Default value is USD.

        • weight string

          The weight of the object

        • weight_unit string

          Values are lb and kg.

        • 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
      • delivery_end string
      • delivery_start string
      • pickup_end string
      • pickup_start string
    • services array[object]
      • amount string
      • amount_currency string
      • included_services array[]
      • is_requested boolean
      • is_required boolean
      • name string
      • sub_subtype string
      • subtype string
      • 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

      Default value is USD.

    • 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
      • detail string
Definition
POST https://api.shiparta.com/shipments
cURL 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" } }

Get a Shipment record

Retrieve an existing Shipment record

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Path 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
      • id string

        The location id

      • address_line_1 string

        First line of address

      • address_line_2 string

        Second line of address

      • address_line_3 string

        Third line of address

      • city string

        City

      • region string

        Political region name, for US states and Canada provinces, use 2 letter abbreviations

      • postal_code string

        The postal code

      • country string

        The ISO 3166-1 alpha-2 country code of the current or last known location if available

      • title string

        The title or name of the location

      • access_restrictions array[string]

        Id of location restriction type

      • contacts array[object]

        An list of contacts at the location

        • name string
        • email_address string
        • phone_number string
    • id string
    • insurance_policy object
      • amount string
      • amount_currency string

        The currency of the insurance amount. Formatted as ISO 4217 three-letter alphabetic currency code

        Default value is USD.

      • id string
      • insured_value string
      • insured_value_currency string

        The currency of the insurance amount. Formatted as ISO 4217 three-letter alphabetic currency code

        Default value is USD.

    • 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
      • id string

        The location id

      • address_line_1 string

        First line of address

      • address_line_2 string

        Second line of address

      • address_line_3 string

        Third line of address

      • city string

        City

      • region string

        Political region name, for US states and Canada provinces, use 2 letter abbreviations

      • postal_code string

        The postal code

      • country string

        The ISO 3166-1 alpha-2 country code of the current or last known location if available

      • title string

        The title or name of the location

      • access_restrictions array[string]

        Id of location restriction type

      • contacts array[object]

        An list of contacts at the location

        • name string
        • email_address string
        • phone_number string
    • packages array[object]
      • depth string
      • handle_with_care boolean
      • height string
      • is_sufficiently_packed boolean
      • packing_materials array[string]

        The id of a material.

      • unit_of_measurement string
      • weight string
      • weight_unit string
      • width string
      • objects array[object]
        • current_packing array[string]

          A list of packing subtype IDs describing how the item is currently packed

        • depth string

          The depth of the object

        • details object
          • creation_date string

            The creation timing for the object

          • creator string

            The creator of the object

          • is_fragile boolean

            Set this flag to true is the item is fragile. This may effect packing and handling costs

          • 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

          • materials array[string]

            A list of ids the types of materials used

          • title string

            The object title

        • height string

          The height of the object

        • images array[string](uri)

          A list image urls of the object

        • 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

        • 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

        • subtype string

          The object sub-type id

        • type string

          The object type id

        • unit_of_measurement string

          Values are in and cm.

        • value string
        • value_currency string

          ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint

          Default value is USD.

        • weight string

          The weight of the object

        • weight_unit string

          Values are lb and kg.

        • 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
      • delivery_end string
      • delivery_start string
      • pickup_end string
      • pickup_start string
    • services array[object]
      • amount string
      • amount_currency string
      • included_services array[]
      • is_requested boolean
      • is_required boolean
      • name string
      • sub_subtype string
      • subtype string
      • 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

      Default value is USD.

    • 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
      • detail string
Definition
GET https://api.shiparta.com/shipments/{shipment_id}
cURL example
curl \ -X GET https://api.shiparta.com/shipments/{shipment_id} \ -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" } }

Trackings

Get Tracking Details

Retrieve Tracking details for a parcel shipment by tracking number

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Path parameters
  • tracking_number Required / string

    tracking_number parameter

Responses
  • • 200 object

    Successful Tracking response

    • content-type string
    • x-arta-request-id string
    • carrier object
      • code string
      • name string
      • phone_number string
      • url string
    • events array[object]
      • code string
      • name string
      • phone_number string
      • url string
    • status string
    • tracking_number string
  • • 404 object

    Resource Not Found

    • content-type string
    • x-arta-request-id string
    • errors object
      • detail string
Definition
GET https://api.shiparta.com/trackings/{tracking_number}
cURL example
curl \ -X GET https://api.shiparta.com/trackings/{tracking_number} \ -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" } }

Webhooks

List Webhooks

Retrieve a paginated collection of Webhooks belonging to your Organization

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Query parameters
  • page_size integer

    Results per page (max 50)

    Default value is 20.

  • page integer

    Page number of the results to fetch.

    Default value is 1.

Responses
  • • 200 object

    A collection of Webhooks

    • content-type string
    • x-arta-request-id string
    • items array[object]
      • id integer(int64)
      • created_at string
      • name string
      • updated_at string
      • url string
    • metadata object
      • page integer(int64)
      • page_size integer(int64)
      • total_count integer(int64)
Definition
GET https://api.shiparta.com/webhooks
cURL example
curl \ -X GET https://api.shiparta.com/webhooks \ -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 } }

Create a Webhook

response

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Body
  • webhook object
    • name string

      The name for this 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
      • detail string
Definition
POST https://api.shiparta.com/webhooks
cURL 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" } }

Get a Webhook

Retrieve an existing Webhook request

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Path 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
      • detail string
Definition
GET https://api.shiparta.com/webhooks/{webhook_id}
cURL example
curl \ -X GET https://api.shiparta.com/webhooks/{webhook_id} \ -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" } }

Delete a Webhook

Delete a Webhook

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Path 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
      • detail string
Definition
DELETE https://api.shiparta.com/webhooks/{webhook_id}
cURL example
curl \ -X DELETE https://api.shiparta.com/webhooks/{webhook_id} \ -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response example (204)
# Headers content-type: string x-arta-request-id: string
Response example (404)
# Headers content-type: string x-arta-request-id: string # Payload { "errors": { "detail": "string" } }

Update a Webhook

Update an existing Webhook request

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Path parameters
  • webhook_id Required / integer

    webhook_id parameter

Body
  • webhook object
    • name string

      The name for this 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
      • 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" } }

Ping a Webhook

Trigger ARTA to deliver a test message to an existing Webhook endpoint

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Path 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
      • detail string
Definition
POST https://api.shiparta.com/webhooks/{webhook_id}/ping
cURL example
curl \ -X POST https://api.shiparta.com/webhooks/{webhook_id}/ping \ -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" } }

Get a Webhook Secret Token

Retrieve the secret token associated with a webhook endpoint resource

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Path parameters
  • webhook_id Required / integer

    webhook_id parameter

Responses
  • • 200 object

    Successful Webhook response

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

      The secret token associated with the webhook endpoint

  • • 404 object

    Resource Not Found

    • content-type string
    • x-arta-request-id string
    • errors object
      • detail string
Definition
GET https://api.shiparta.com/webhooks/{webhook_id}/secret_token
cURL example
curl \ -X GET https://api.shiparta.com/webhooks/{webhook_id}/secret_token \ -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response example (200)
# Headers content-type: string x-arta-request-id: string # Payload { "secret_token": "zASePCHfe2FYKjXl1YhFukNY5T7hCqgX0RRBUVi_289ubnhBvN9U03uOqG8oB2Oz" }
Response example (404)
# Headers content-type: string x-arta-request-id: string # Payload { "errors": { "detail": "string" } }

Reset a Webhook Secret Token

Regenerate the secret token associated with a webhook endpoint resource

Headers
  • Authorization Required / string

    Authorize your API calls with an ARTA API token

Path parameters
  • webhook_id Required / integer

    webhook_id parameter

Responses
  • • 200 object

    Successful Webhook response

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

      The new secret token associated with the webhook endpoint

  • • 404 object

    Resource Not Found

    • content-type string
    • x-arta-request-id string
    • errors object
      • detail string
Definition
PATCH https://api.shiparta.com/webhooks/{webhook_id}/secret_token/reset
cURL example
curl \ -X PATCH https://api.shiparta.com/webhooks/{webhook_id}/secret_token/reset \ -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response example (200)
# Headers content-type: string x-arta-request-id: string # Payload { "secret_token": "zASePCHfe2FYKjXl1YhFukNY5T7hCqgX0RRBUVi_289ubnhBvN9U03uOqG8oB2Oz" }
Response example (404)
# Headers content-type: string x-arta-request-id: string # Payload { "errors": { "detail": "string" } }