curl -X POST https://artport.co/api/v1/reports/1/1 \
    -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    -F "box[]=@/path/to/box_1.jpg" \
    -F "box[]=@/path/to/box_2.jpg" \
    -F "box[]=@/path/to/box_3.jpg" \
    -F "box[]=@/path/to/box_4.jpg" \
    -F "box[]=@/path/to/box_5.jpg" \
    -F "box[]=@/path/to/box_6.jpg" \
    -F "art[]=@/path/to/art_1.jpg" \
    -F "art[]=@/path/to/art_2.jpg" \
    -F "art[]=@/path/to/art_3.jpg" \
    -F "art[]=@/path/to/art_4.jpg" \
    -F "art[]=@/path/to/art_5.jpg" \
    -F "art[]=@/path/to/art_6.jpg"
No content

Overview

This endpoint can be used to store the condition report for a given shipment.

Endpoint: /api/v1/reports/{shipment_id}/{set}

Method: POST

A shipment’s condition report is made up of two “sets”.

Set 1 contains the photos of the shipment (artwork and box) before it is shipped.

Set 2 contains the photos of the shipment (artwork and box) after it is received.

Requirements

In order to submit Set 1, the shipment’s status must be Delivered, and the submission must be made within 30 days of the shipment’s arrival at the fulfillment address.

In order to submit Set 2, the shipment’s status must be Arrived, and the submission must be made within 24 hours of the shipment’s arrival at the destination address.

URL Parameters

shipment_id
integer
required

The ID of the shipment.

set
integer
required

The set being uploaded. This can be either 1 or 2.

Request

Since the request requires that photos (binary files) are included, you will need to ensure that the request is sent using multipart/form-data.

box
array
required

An array of photos that document the condition of the shipment’s box.

Required number of photos: 6.

Maximum file size for each photo: 1MB.

Permitted file types for the photo: JPG, PNG.

The photos should be ordered within the array like so:

  • Front surface
  • Back surface
  • Top surface
  • Bottom surface
  • Left surface
  • Right surface
art
array
required

An array of photos that document the condition of the shipment’s artwork.

Required number of photos: 6.

Maximum file size for each photo: 1MB.

Permitted file types for the photo: JPG, PNG.

The photos should be ordered within the array like so:

  • Front surface
  • Back surface
  • Top surface
  • Bottom surface
  • Left surface
  • Right surface
curl -X POST https://artport.co/api/v1/reports/1/1 \
    -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    -F "box[]=@/path/to/box_1.jpg" \
    -F "box[]=@/path/to/box_2.jpg" \
    -F "box[]=@/path/to/box_3.jpg" \
    -F "box[]=@/path/to/box_4.jpg" \
    -F "box[]=@/path/to/box_5.jpg" \
    -F "box[]=@/path/to/box_6.jpg" \
    -F "art[]=@/path/to/art_1.jpg" \
    -F "art[]=@/path/to/art_2.jpg" \
    -F "art[]=@/path/to/art_3.jpg" \
    -F "art[]=@/path/to/art_4.jpg" \
    -F "art[]=@/path/to/art_5.jpg" \
    -F "art[]=@/path/to/art_6.jpg"

Response

If the condition report is successfully stored, the API will return a 201 Created status code.

The response will not contain any content.

No content