Skip to main content

​
Overview

This endpoint can be used to update a shipment. Endpoint: /api/v1/shipments/{shipment_id} Method: PATCH
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.

​
URL Parameters

​
shipment_id
integer
required
The ID of the shipment you wish to .

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

​
Response

If the shipment is successfully updated, the API will return a 204 No Content status code. The response will not contain any content. 
{
    "title": "Test Shipment",
    "value": 1000,
    "length": 17,
    "height": 13,
    "depth": 1,
    "service": 1,
    "fulfillment_address_id": 123,
    "destination_address_id": 456
}

No Content