Create a Shipment
POST
/shipments
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.
POST /shipments
curl \
-X POST https://api.arta.io/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 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 examples (200)
# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx
# Payload
{
"created_at": "2021-01-21T21:00:58.403150",
"destination": {
"access_restrictions": [
"string"
],
"address_line_1": "87 Richardson St",
"address_line_2": "string",
"address_line_3": "string",
"city": "Brooklyn",
"country": "US",
"postal_code": "11211",
"region": "NY",
"title": "Gallery",
"contacts": [
{
"name": "Contact Name",
"email_address": "docs@arta.io",
"phone_number": "646 828 7333"
}
]
},
"eei_form_status": null,
"emissions": "0.03",
"emissions_unit": "kg_co2e",
"exceptions": [
{
"created_at": "2023-05-02T20:02:55.293191",
"exception_type_label": "string",
"package_id": 42,
"id": "3344befd-7e7c-47f9-8379-4b2a828f77fb",
"resolution": "string",
"status": "new",
"type": "prepayment_required",
"updated_at": "2023-05-02T20:02:55.293191"
}
],
"hosted_session_id": 42,
"id": "6b12c76a-5217-4cd6-82d8-7aa5265ebaad",
"insurance_policy": {
"amount": "5.00",
"amount_currency": "USD",
"id": "arta_transit_insurance",
"insured_value": "1500.00",
"insured_value_currency": "USD"
},
"internal_reference": "user #42",
"log_request_id": "Fv7_XBZcofxdL3kAqmIh",
"object_count": 1,
"origin": {
"access_restrictions": [
"string"
],
"address_line_1": "87 Richardson St",
"address_line_2": "string",
"address_line_3": "string",
"city": "Brooklyn",
"country": "US",
"postal_code": "11211",
"region": "NY",
"title": "Gallery",
"contacts": [
{
"name": "Contact Name",
"email_address": "docs@arta.io",
"phone_number": "646 828 7333"
}
]
},
"package_count": 1,
"packages": [
{
"depth": "5.0",
"eta": "05/09/2022",
"handle_with_care": true,
"height": "5.0",
"id": 14232,
"is_sufficiently_packed": true,
"objects": [
{
"current_packing": [
"string"
],
"depth": "string",
"details": {
"creation_date": "string",
"creator": "string",
"is_fragile": false,
"is_cites": false,
"materials": [
"string"
],
"title": "string"
},
"height": "string",
"id": 1498,
"images": [
"https://example.com"
],
"internal_reference": "string",
"public_reference": "string",
"subtype": "string",
"type": "string",
"unit_of_measurement": "in",
"value": "2500",
"value_currency": "USD",
"weight": "string",
"weight_unit": "lb",
"width": "string"
}
],
"packing_materials": [
"string"
],
"status": "pending",
"unit_of_measurement": "in",
"weight": "1.0",
"weight_unit": "lb",
"width": "5.0"
}
],
"payment_process": "checkout",
"public_reference": "Order 554",
"quote_type": "parcel",
"schedule": {
"delivery_end": "string",
"delivery_start": "string",
"delivery_window_modifier": "string",
"pickup_end": "string",
"pickup_start": "string",
"pickup_window_modifier": "string"
},
"services": [
{
"amount": "string",
"amount_currency": "string",
"included_services": [],
"is_requested": true,
"is_required": true,
"name": "string",
"sub_subtype": "string",
"subtype": "string",
"type": "string"
}
],
"shipping_notes": "string",
"shortcode": "DEMO-572652",
"status": "pending",
"total": "2500",
"total_currency": "USD",
"tracking": [
{
"carrier_name": "string",
"label_url": "string",
"package_id": 42,
"tracking_number": "string",
"url": "string"
}
],
"updated_at": "2021-01-21T21:00:58.403150",
"url": "https://app.arta.io/tracking/6b12c76a-5217-4cd6-82d8-7aa5265ebaad/5xTRnCvYkMFdcFFMWUZaCmXz"
}
Response examples (404)
# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx
# Payload
{
"errors": {
"detail": "string"
}
}