Create a Shipment
This endpoint is used for two purposes:
1. Generating standard Arta shipments
All standard shipments are actively facilitated by Arta. Working in tandem with our extensive logistics carrier network, Arta fulfills shipments with Premium
, Select
, and Parcel
quote types from scheduling collection, to coordinating packing, through delivery. For shipments with the Self Ship
quote type, Arta will generate labels on your behalf with commercial carriers such as FedEx, UPS, and DHL.
To book a standard Arta shipment, you must first create a shipping quote request. You can then use a quote_id
returned by the quote request endpoint to create the shipment.
2. Generating Track shipments
Track shipments provide a similar customer tracking and notification experience as standard Arta shipments but for shipments you have booked with commercial carriers outside of the Arta platform.
To create a Track shipment, you provide the carrier
and tracking_number
purchased externally and the Arta platform provides status automation, tracking pages, and customer notifications. You may optionally provide additional supplementary information such as origin, destination, and package details for Track shipments.
Note that Track shipments are a beta feature. Please contact your account manager or hello@arta.io to request access for your organization.
curl \
-X POST https://api.arta.io/shipments \
-H "Content-Type: application/json" \
-H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
-d '{"shipment":{"quote_id":26234,"public_reference":"Order #22"}}'
{
"shipment": {
"quote_id": 26234,
"public_reference": "Order #22"
}
}
{
"shipment": {
"tracking": [
{
"url": "https://www.ups.com/track?trackNums=1ZE50d7272&loc=en_US&requester=ST/trackdetails",
"carrier": "ups",
"tracking_number": "1ZE50d7272"
}
],
"public_reference": "order 4279"
}
}
{
"shipment": {
"origin": null,
"packages": [
{
"objects": [
{
"depth": "4",
"value": "2400.00",
"width": "16",
"value_currency": "USD",
"unit_of_measurement": "in"
}
]
}
],
"tracking": [
{
"url": "https://www.ups.com/track?trackNums=1ZE5002cda3&loc=en_US&requester=ST/trackdetails",
"carrier": "ups",
"tracking_number": "UPSTrackingNumber"
}
],
"destination": {
"city": "Amherst",
"region": "MA",
"country": "US",
"contacts": [
{
"name": "Ami Collector",
"phone_number": "(212) 212-2121",
"email_address": "destination@example.com"
}
],
"postal_code": "01002"
},
"public_reference": "Order #5428",
"internal_reference": "C6231"
}
}
{
"id": "6b12c76a-5217-4cd6-82d8-7aa5265ebaad",
"url": "https://app.arta.io/tracking/6b12c76a-5217-4cd6-82d8-7aa5265ebaad/5xTRnCvYkMFdcFFMWUZaCmXz",
"total": "19.56",
"origin": {
"city": "Brooklyn",
"title": "Gallery",
"region": "NY",
"country": "US",
"contacts": [
{
"name": "Origin Name",
"phone_number": "310 713 7333",
"email_address": "docs@arta.io"
}
],
"postal_code": "11211",
"address_line_1": "310 Bergen St",
"address_line_2": "Suite 405",
"address_line_3": null,
"access_restrictions": []
},
"status": "pending",
"packages": [
{
"id": 8320325,
"eta": "05/09/2022",
"depth": "5.0",
"width": "5.0",
"height": "5.0",
"status": "pending",
"weight": "1.0",
"objects": [
{
"id": 1498,
"type": "art",
"depth": "4",
"value": "2500",
"width": "20",
"height": "16",
"images": [],
"weight": "4",
"details": {
"title": "The whale",
"creator": "Jasper Smith",
"is_cites": false,
"materials": [],
"is_fragile": false,
"creation_date": "October 2023"
},
"subtype": "work_on_paper_framed",
"weight_unit": "lb",
"value_currency": "USD",
"current_packing": [],
"public_reference": null,
"internal_reference": null,
"unit_of_measurement": "in"
}
],
"weight_unit": "lb",
"handle_with_care": true,
"packing_materials": [
"strongbox"
],
"unit_of_measurement": "in",
"is_sufficiently_packed": true
}
],
"schedule": {
"pickup_end": null,
"delivery_end": null,
"pickup_start": null,
"delivery_start": null,
"pickup_window_modifier": "",
"delivery_window_modifier": ""
},
"services": [
{
"name": "Ground",
"type": "transport",
"amount": "19.56",
"subtype": "parcel",
"is_required": true,
"sub_subtype": "ground",
"is_requested": false,
"amount_currency": "USD",
"included_services": []
},
{
"name": "Signature Required",
"type": "location",
"amount": "0.00",
"subtype": "delivery",
"is_required": true,
"sub_subtype": "signature_delivery",
"is_requested": false,
"amount_currency": "USD",
"included_services": []
}
],
"tracking": [
{
"url": "https://www.ups.com/track?loc=en_us&tracknum=1zw475770393992448&Requester=NS/",
"label_url": null,
"package_id": 8320325,
"carrier_name": "UPS",
"tracking_number": "1zw475770393992448"
}
],
"emissions": "0.03",
"shortcode": "DEMO-572652",
"created_at": "2021-01-21T21:00:58.403150",
"exceptions": [],
"quote_type": "self_ship",
"updated_at": "2021-01-21T21:00:58.403150",
"destination": {
"city": "Brooklyn",
"title": "Gallery",
"region": "NY",
"country": "US",
"contacts": [
{
"name": "Contact Name",
"phone_number": "917 818 0440",
"email_address": "docs@arta.io"
}
],
"postal_code": "11211",
"address_line_1": "87 Richardson St",
"address_line_2": null,
"address_line_3": null,
"access_restrictions": []
},
"eei_form_url": null,
"object_count": 1,
"package_count": 1,
"emissions_unit": "kg_co2e",
"log_request_id": "Fv7_XBZcofxdL3kAqmIh",
"shipping_notes": "Booked via webstore",
"total_currency": "USD",
"eei_form_status": null,
"payment_process": "checkout",
"insurance_policy": {
"id": "arta_transit_insurance",
"amount": "5.00",
"insured_value": "1500.00",
"amount_currency": "USD",
"insured_value_currency": "USD"
},
"public_reference": "Order 554",
"hosted_session_id": null,
"internal_reference": "user #42"
}
# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx
# Payload
{
"errors": {
"detail": "string"
}
}
{
"errors": {
"tracking/0": [
"Required property carrier was not present."
]
}
}
{
"errors": {
"quote/status": [
"cannot be booked in the current status"
]
}
}