---
title: "Get list of shipment carrier documents."
method: GET
path: "/rest/api/shipping/carrier-document/"
tags: ["Shipment"]
---

# Get list of shipment carrier documents.

`GET /rest/api/shipping/carrier-document/`

List of carrier documents for carrier accounts

## Query parameters

- `carrierAccountId[]` integer[]
- `createdAtAfter` string, date-time — Date of shipment carrier document creation from in Apilo, takes the value of ISO 8601 date encoded to URL, e.g. <code>2022-03-01T14:40:33%2B0200</code>
- `createdAtBefore` string, date-time — Date of shipment carrier document creation from in Apilo, takes the value of ISO 8601 date encoded to URL, e.g. <code>2022-03-01T14:40:33%2B0200</code>

## Response `200`

Returns list of shipment carrier documents

- RestShipmentCarrierDocumentsListingResponse
  - `documents` RestShipmentCarrierDocumentDTO[] — List of shipment carrier documents
    - `id` integer — Internal document ID
    - `carrierAccountId` integer — Carrier account ID
    - `createdAt` string, date-time, nullable — Date the document was created in Apilo
    - `type` integer, nullable — Document type - <a href='#tag/order/paths/~1rest~1api~1orders~1documents~1map~1/get'>order document types endpoint</a>
    - `media` string — Null or media UUID - <a href='#tag/media/operation/get_rest_media_get'>media attachment endpoint</a>
  - `totalCount` integer — Number of matching results
  - `currentOffset` integer — Current list offset
  - `pageResultCount` integer — Number of results per page

## Other responses

- `401` — Authorization failed

---

[API](https://skmtc.dev/apilo/apis/apilo-rest-api.md) · [All operations](https://skmtc.dev/apilo/apis/apilo-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/apilo/apilo-rest-api/revisions/a0f9dcdba6cc/schema)
