Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB
Services

Get a service

Retrieve a service by ID.

The response includes vendor info and charges.

get/services/{id}

Path parameters

idstring required

Resource ID (UUID) or client key

Query parameters

by'id' | 'key'

Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.

Response

Service retrieved successfully

idstring uuid required
keystring nullable

Human-readable service ID

shipmentIdstring uuid

Parent shipment

shipmentKeystring nullable

Parent shipment friendly ID

serviceType'DRAYAGE' | 'CUSTOMS_CLEARANCE' | 'WAREHOUSING' | 'CROSS_DOCK' | 'TRANSLOAD' | 'FUMIGATION' | 'INSPECTION' | 'DOCUMENTATION' | 'INSURANCE' | 'CARGO_HANDLING' | 'OTHER'

Type of service.

  • DRAYAGE: Port/rail drayage
  • CUSTOMS_CLEARANCE: Customs brokerage
  • WAREHOUSING: Warehouse storage
  • CROSS_DOCK: Cross-dock handling
  • TRANSLOAD: Transloading service
  • FUMIGATION: Cargo fumigation
  • INSPECTION: Cargo inspection
  • DOCUMENTATION: Documentation handling
  • INSURANCE: Cargo insurance
  • CARGO_HANDLING: General cargo handling
  • OTHER: Other service type
status'ACTIVE' | 'AWAITING_INVOICE' | 'INVOICE_IN_REVIEW' | 'APPROVED_TO_PAY' | 'PAID' | 'CANCELED' required

Current status of the service.

Active states:

  • ACTIVE: Service is active/in progress

Billing states (AP):

  • AWAITING_INVOICE: Waiting for vendor invoice
  • INVOICE_IN_REVIEW: Invoice received, under review
  • APPROVED_TO_PAY: Approved for payment
  • PAID: Paid to vendor

Final states:

  • CANCELED: Service canceled
descriptionstring nullable

Service description

totalCostnumber nullable

Sum of all charges

scheduledDatestring date nullable
completedDatestring date nullable
referenceNumberstring nullable

Vendor reference number

createdAtstring date-time required
updatedAtstring date-time nullable

Example response

{
  "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"
      }
    }
  ]
}