v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB
Services

Filter services

Search for services using filter criteria.

Common Filters

  • By shipment: { "filter": { "shipmentId": { "equalTo": "uuid" } } }
  • By vendor: { "filter": { "vendorId": { "equalTo": "uuid" } } }
  • Awaiting invoice: { "filter": { "status": { "equalTo": "AWAITING_INVOICE" } } }
post/services/filter

Request body

pageSizeinteger
cursorstring

Response

Services matching filter criteria

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "key": "SVC-12345",
      "vendor": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "key": "ERP-VENDOR-ABC-001",
        "friendlyId": "V123456",
        "name": "ABC Warehouse Services",
        "email": "billing@abcwarehouse.com",
        "phone": "+1-555-123-4567",
        "status": "ACTIVE",
        "currency": "USD",
        "createdAt": "2025-01-15T10:00:00Z",
        "updatedAt": "2025-01-15T14:30:00Z"
      },
      "charges": [
        {
          "chargeCode": {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "key": "ERP-USER-12345"
          }
        }
      ]
    }
  ],
  "pagination": {
    "pageSize": 50,
    "hasNextPage": true,
    "endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
  }
}