Create Shipment - Developer Portal

Overview

This endpoint can be used to create new shipments. A maximum of 10 shipments can be created in a single request. Endpoint: /api/v1/shipments Method: POST

It is critical that you verify the fulfillment and destination addresses before using them.Failure to verify the addresses may result in loss or delayed shipments.You may also be charged should address correction be necessary by the carrier.

Request

When creating a shipment, you can use either of the following two approaches to specify the fulfillment and destination addresses:

Use the fulfillment_address_id and destination_address_id fields to reference existing addresses that have already been stored on ArtPort.
Provide the address details directly in the fulfillment_address and destination_address fields.

You can also combine these approaches. For example, by using a fulfillment_address_id and a destination_address, or vice versa.For examples of how to use these fields, see the request examples on this page.

shipments

array

required

Array of shipment objects to be created.Minimum objects in the array: 1Maximum objects in the array: 10Each shipment object must consist of the following fields:

Hide shipments

title

string

required

The name or a brief description of the piece. You can also use an internal reference number.Minimum character length: 2Maximum character length: 50

value

integer

required

The value of the artwork in USD $.Always use an accurate value to make sure that any insurance claims are properly honored.Minimum value: 50Maximum value: 10000

length

integer

required

The length of the piece in inches.Minimum length: 17Maximum length: 44

height

integer

required

The height of the piece in inches.Minimum height: 13Maximum height: 34

depth

integer

required

The depth of the piece in inches.Minimum depth: 1Maximum depth: 4

service

integer

required

A Service enum representing the service to be used for the shipment.

fulfillment_address_id

integer

The ID of an existing address to be used as the fulfillment address.

This field is required if the fulfillment_address field is not provided.

fulfillment_address

array

An object containing the fulfillment address details.

This field is required if the fulfillment_address_id field is not provided.

Hide fulfillment_address

name

string

required

For example, “John Smith” or “Acme Products”.Minimum character length: 2Maximum character length: 50

string

required

The contact email address.Carriers may send one or more shipment tracking notifications to this email address.Minimum character length: 6Maximum character length: 100

phone

string

required

The contact phone number.This must be formatted using the E.164 standard.Minimum character length: 7Maximum character length: 30

line_1

string

required

Line 1 of the address.Minimum character length: 2Maximum character length: 35

line_2

string

Line 2 of the address.Minimum character length: 2Maximum character length: 35

city

string

required

The address’ town or city.Minimum character length: 2Maximum character length: 35

region

string

required

The address’ state, province, or region.Minimum character length: 2Maximum character length: 30

post_code

string

required

The address’ post code.Minimum character length: 2Maximum character length: 16

country

integer

required

A Country enum representing the address’ country.

destination_address_id

integer

The ID of an existing address to be used as the destination address.

This field is required if the destination_address field is not provided.

destination_address

array

An object containing the destination address details.

This field is required if the destination_address_id field is not provided.

Hide destination_address

name

string

required

For example, “John Smith” or “Acme Products”.Minimum character length: 2Maximum character length: 50

string

required

The contact email address.Carriers may send one or more shipment tracking notifications to this email address.Minimum character length: 6Maximum character length: 100

phone

string

required

The contact phone number.This must be formatted using the E.164 standard.Minimum character length: 7Maximum character length: 30

line_1

string

required

Line 1 of the address.Minimum character length: 2Maximum character length: 35

line_2

string

Line 2 of the address.Minimum character length: 2Maximum character length: 35

city

string

required

The address’ town or city.Minimum character length: 2Maximum character length: 35

region

string

required

The address’ state, province, or region.Minimum character length: 2Maximum character length: 30

post_code

string

required

The address’ post code.Minimum character length: 2Maximum character length: 16

country

integer

required

A Country enum representing the address’ country.

Response

If the shipments are successfully created, the API will return a 201 Created status code. The response will contain the following content:

shipments

array

required

Details of the newly created shipments.

Hide shipments

integer

required

The ID of the newly created shipment.

title

string

required

The title of the newly created shipment.

{
    "shipments": [
        {
            "title": "Test Shipment",
            "value": 1000,
            "length": 17,
            "height": 13,
            "depth": 1,
            "service": 1,
            "fulfillment_address_id": 123,
            "destination_address_id": 456,
        },
        // Additional shipments to be created...
    ]
}

{
    "shipments": [
        {
            "id": 10011,
            "title": "Shipment 1",
        },
        {
            "id": 10012,
            "title": "Shipment 2",
        }
    ]
}

Documentation Index

​Overview

​Request

​Response

Overview

Request

Response