Shipment

{
    "id": 1,
    "title": "Secured local capability",
    "value": 7431,
    "status": 2,
    "box": 2,
    "length": 37,
    "height": 21,
    "depth": 1,
    "service": 1,
    "fulfillment_address": {
        "id": 2,
        "name": "Gaylord-Ratke",
        "email": "warren25@hotmail.com",
        "phone": "+12069536978",
        "line_1": "684 Kiley Cape",
        "line_2": "Suite 269",
        "city": "Bednarburgh",
        "region": "Idaho",
        "post_code": "29709",
        "country": 1,
        "created_at": "2024-12-09 15:39:37",
        "updated_at": "2024-12-09 15:39:37"
    },
    "destination_address": {
        "id": 3,
        "name": "Weissnat-Larkin",
        "email": "weimann.aylin@gmail.com",
        "phone": "+12069536978",
        "line_1": "141 Chaim Mountains",
        "line_2": "Apt. 556",
        "city": "Lake Kamron",
        "region": "South Dakota",
        "post_code": "43650-3558",
        "country": 1,
        "created_at": "2024-12-09 15:39:37",
        "updated_at": "2024-12-09 15:39:37"
    },
    "price": 245,
    "journey_1_carrier": 2,
    "journey_1_tracking_number": "AX56",
    "journey_1_tracking_page_url": "https://carrier2.com/track/AX56",
    "journey_2_carrier": 3,
    "journey_2_tracking_number": "JR87",
    "journey_2_tracking_page_url": "https://carrier3.com/track/JR87",
    "created_at": "2024-12-09 15:39:37",
    "updated_at": "2024-12-09 15:39:37"
},

integer

required

ID of the shipment.

string

required

The name or a brief description of the piece.

integer

required

The value of the artwork in USD $.

integer

required

A Shipment Status enum representing the status of the shipment.

integer

required

A Box Type enum representing the box to be used for the shipment.

integer

required

The length of the piece in inches.

integer

required

The height of the piece in inches.

integer

required

The depth of the piece in inches.

integer

required

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

object

required

An Address object which represents the fulfillment address.

array

required

An Address object which represents the destination address.

integer

The total price in U.S. Dollars to send the artwork.

integer

A Carrier enum representing the provider handling the first journey of the shipment (sending empty box to fulfillment address).

string

The tracking number for the first journey of the shipment.

string

The URL to the tracking page for the first journey of the shipment.

integer

A Carrier enum representing the provider handling the second journey of the shipment (sending packed box to destination address).

string

The tracking number for the second journey of the shipment.

string

The URL to the tracking page for the second journey of the shipment.

string

required

Timestamp of when the shipment was created.

string

required

Timestamp of when the shipment was last updated.

{
    "id": 1,
    "title": "Secured local capability",
    "value": 7431,
    "status": 2,
    "box": 2,
    "length": 37,
    "height": 21,
    "depth": 1,
    "service": 1,
    "fulfillment_address": {
        "id": 2,
        "name": "Gaylord-Ratke",
        "email": "warren25@hotmail.com",
        "phone": "+12069536978",
        "line_1": "684 Kiley Cape",
        "line_2": "Suite 269",
        "city": "Bednarburgh",
        "region": "Idaho",
        "post_code": "29709",
        "country": 1,
        "created_at": "2024-12-09 15:39:37",
        "updated_at": "2024-12-09 15:39:37"
    },
    "destination_address": {
        "id": 3,
        "name": "Weissnat-Larkin",
        "email": "weimann.aylin@gmail.com",
        "phone": "+12069536978",
        "line_1": "141 Chaim Mountains",
        "line_2": "Apt. 556",
        "city": "Lake Kamron",
        "region": "South Dakota",
        "post_code": "43650-3558",
        "country": 1,
        "created_at": "2024-12-09 15:39:37",
        "updated_at": "2024-12-09 15:39:37"
    },
    "price": 245,
    "journey_1_carrier": 2,
    "journey_1_tracking_number": "AX56",
    "journey_1_tracking_page_url": "https://carrier2.com/track/AX56",
    "journey_2_carrier": 3,
    "journey_2_tracking_number": "JR87",
    "journey_2_tracking_page_url": "https://carrier3.com/track/JR87",
    "created_at": "2024-12-09 15:39:37",
    "updated_at": "2024-12-09 15:39:37"
},

Get Started

Concepts

API Endpoints

Schemas

Enums