Skip to main content

​
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:

​
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.
{
    "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",
        }
    ]
}