Skip to main content

​
Overview

This endpoint can be used to retrieve a list of shipments. Endpoint: /api/v1/shipments Method: GET
This endpoint returns a paginated response.

​
Response

If the shipments are successfully retrieved, the API will return a 200 OK status code. The response will contain the following content:
​
data
array
required
An array of Shipment objects.If no shipments are found, the data field will be an empty array.
​
links
array
required
URLs for the first, last, previous, and next pages.Explained in further detail in the pagination guide.
​
meta
array
required
Metadata about the current page.Explained in further detail in the pagination guide.
{
    "data": [
        {
            "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"
            },
            "created_at": "2024-12-09 15:39:37",
            "updated_at": "2024-12-09 15:39:37"
        },
        // Additional shipments...
    ],
    "links": {
        "first": "https://app.artport.co/api/v1/shipments?page=1",
        "last": null,
        "prev": null,
        "next": "https://app.artport.co/api/v1/shipments?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "https://app.artport.co/api/v1/shipments",
        "per_page": 20,
        "to": 20
    }
}