# Create a Shipment

**POST /shipments**

This endpoint is used for two purposes:

**1. Generating standard Arta shipments**

All [standard shipments](https://manual.arta.io/guides/logistics/workflow) 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](https://manual.arta.io/guides/solutions/no-code/post-sale/tracking/track) 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._


## Servers
- https://api.arta.io: https://api.arta.io ()



## Parameters
### Headers
- **Authorization** (string)
  Authorize your API calls with an Arta API token



### Body: application/json (object)

- **shipment** (object)



## Responses
### 201
The created shipment
#### Headers
- **content-type** (string)

- **x-arta-request-id** (string)
  A unique identifier for the Arta API call

#### Body: application/json (object)
- **created_at** (string(date-time))
  A NaiveDatetime-formatted timestamp describing when the resource was created with microsecond precision
- **destination** (object)

- **eei_form_status** (string | null)
  The status of an associated electronic export information document required for customs clearance. Returns null if the shipment does not have an associated EEI Form
- **eei_form_url** (string | null)
  The URL for an associated electronic export information form required for customs clearance. Returns null if the shipment does not have an associated EEI Form
- **emissions** (string | null)
  The estimated CO2 emissions for the shipment
- **emissions_unit** (string | null)
  The unit of measurement for emissions for this shipment. Typically measured in "kg_co2e" or "kilograms of carbon dioxide equivalent"
- **exceptions** (array[object])
  Shipment exceptions provide context about holds, delays, and other circumstances that may interrupt a shipment's fulfillment
- **hosted_session_id** (integer | null)
  The ID of the HostedSession through which this shipment was created
- **id** (string(uuid))
  The id of the shipment in UUID format
- **insurance_policy** (object | null)

- **internal_reference** (string | null)
  This field can be used to pass through any character data that you may want returned unaltered for your own later usage
- **log_request_id** (string | null)
  A string identifying the API request that created the shipment. This `log_request_id` may be used to find the Log associated with the source API request
- **object_count** (integer(int64))
  The count of objects included in the shipment
- **origin** (object)

- **package_count** (integer(int64))
  The count of packages included in the shipment
- **packages** (array[object])

- **payment_process** (string)
  The primary method by which payment to Arta will be handled for any shipment booked through this hosted session
- **public_reference** (string | null)
  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)
  The schedule for the shipment
- **services** (array[object])
  A list of services included in the shipment
- **shipping_notes** (string | null)
  Any additional unstructured notes to Arta about the shipment
- **shortcode** (string)
  A brief identifier for this shipment
- **status** (string)
  The status for this shipment
- **tags** (array[object])
  A list of tags associated with the shipment
- **total** (string)

- **total_currency** (string)
  ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint
- **tracking** (array[object])
  A list of tracking details for the packages in a shipment
- **updated_at** (string(date-time))
  A NaiveDatetime-formatted timestamp describing when the resource was last updated with microsecond precision
- **url** (string)
  The track URL for this shipment on the Arta web platform

### 400
Bad Request
#### Headers
- **content-type** (string)

- **x-arta-request-id** (string)
  A unique identifier for the Arta API call

#### Body: application/json (object)
- **errors** (object)


### 403
Forbidden

### 404
Not Found
#### Headers
- **content-type** (string)

- **x-arta-request-id** (string)
  A unique identifier for the Arta API call

#### Body: application/json (object)
- **errors** (object)


### 422
Unprocessible entity

#### Body: application/json (object)
- **errors** (object)



[Powered by Bump.sh](https://bump.sh)