Services

GET /metadata/services

The list of shipment services supported by Arta's API.

Headers

  • Authorization string Required

    Authorize your API calls with an Arta API token

Responses

  • 200 application/json

    A collection of service types

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • A long form description

    • id string

      The ID representing the resource

    • name string

      A brief title for the resource

    • subtypes array[object]

      The subtypes for this resource

      Hide subtypes attributes Show subtypes attributes object

      An object subtype

      • A long form description

      • id string

        The ID representing the resource

      • name string

        A brief title for the resource

      • sub_subtypes array[object]

        The subtypes for this resource

        Hide sub_subtypes attributes Show sub_subtypes attributes object

        An object subtype

        • A long form description

        • id string

          The ID representing the resource

        • Whether this service is requestable by the client

        • name string

          A brief title for the resource

GET /metadata/services
curl \
 -X GET https://api.arta.io/metadata/services \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response examples (200)
# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
[
  {
    "description": "All handling for items at location and in transit.",
    "id": "handling",
    "name": "Handling Services",
    "subtypes": [
      {
        "description": "All installation services.",
        "id": "installation",
        "name": "Installation",
        "sub_subtypes": [
          {
            "description": "Object assembly at the destination",
            "id": "assembly",
            "is_requestable": true,
            "name": "Assembly"
          }
        ]
      }
    ]
  }
]