List ShipmentOrder

GET

/api/shipment-orders

A shipment order is a document used by organizations to specify what items are being transferred from a storage location to a person at a new destination. It accompanies the shipment so the recipient can confirm they received the correct items.

Filtering

filter[name]=HelloFromMakiniAPI

filter[name:contains]=Makini

filter[name:startsWith]=Hello

filter[name:startsWith]=API

filter[createdAt:gt]=2023-11-07

filter[createdAt:gteq]=2023-11-07

filter[createdAt:lt]=2023-11-07

filter[createdAt:lted]=2023-11-07

Filter matching

filterMatch=any // OR

filterMatch=all // AND

Sorting

sort[createdAt]=1 // DESC

sort[createdAt]=0 // ASC

Request

Authorization

Query Params

Responses

🟢200

application/json

Successful operation

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/shipment-orders?filter&page&sort&per_page'

Response Example

{
    "data": [
        {
            "key": "05000936730839",
            "userKey": "06000282537760",
            "customerKey": "06000238513313",
            "vendorKey": "08000673910108",
            "orderNumber": "string",
            "shipmentNumber": "string",
            "date": "string",
            "statusKey": "05000842221080",
            "lineItems": [
                {
                    "productKey": "00000562598856",
                    "materialKey": "01000777786867",
                    "quantity": "string",
                    "locationKey": "00000529650795",
                    "storeroomKey": "05000319930116"
                }
            ],
            "destinationAddress": [
                {
                    "country": "string",
                    "addressLines": "string",
                    "addressee": "string",
                    "state": "string",
                    "city": "string",
                    "postCode": "string",
                    "phone": "string",
                    "email": "string",
                    "notes": "string",
                    "isActive": "true",
                    "createdAt": "2002-06-10T13:07:48Z",
                    "updatedAt": "2006-09-17T16:00:16Z"
                }
            ],
            "carrierName": "string",
            "shippingMethod": "string",
            "notes": "string",
            "createdAt": "1988-03-06T05:11:31Z",
            "updatedAt": "2015-12-12T08:06:11Z",
            "deletedAt": "2005-06-10T07:10:09Z"
        }
    ],
    "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
    },
    "meta": {
        "current_page": 0,
        "from": 0,
        "last_page": 0,
        "path": "string",
        "per_page": 0,
        "to": 0,
        "total": 0
    }
}

Modified at 2026-03-19 15:49:21

Get a ServiceRequest

Get a ShipmentOrder