Skip to main content
POST
/
graphql#ListIntegrationCarrierMappings
List integration carrier mappings
curl --request POST \
  --url 'https://clarus-api.com/graphql#ListIntegrationCarrierMappings' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: IntegrationCarrierMappingFilterType) { integration_carrier_mappings { all(filter: $filter) { edges { node { id carrier { id } carrier_service { id } integration_carrier { id code } mapping_fields mapping_group_id } } } } }"
}
'
{
  "data": {
    "integration_carrier_mappings": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "5",
              "carrier": {
                "id": "12"
              },
              "carrier_service": {
                "id": "34"
              },
              "integration_carrier": {
                "id": "901",
                "code": "DPD"
              },
              "mapping_fields": [
                {
                  "carrier_code_in_file": "DPD-NEXTDAY"
                }
              ],
              "mapping_group_id": "7"
            }
          }
        ]
      }
    }
  }
}

​
Query Structure

query($filter: IntegrationCarrierMappingFilterType) {
  integration_carrier_mappings {
    all(filter: $filter) {
      edges {
        node {
          id
          carrier { id }
          carrier_service { id }
          integration_carrier { id code }
          mapping_fields
          mapping_group_id
        }
      }
    }
  }
}

​
Filter Argument

All filters are passed inside the filter argument. Each filter field accepts an input object with operators (e.g. eq, ilike, from, to, between): 
{
  "filter": {
    "mapping_group_id": {
      "eq": "value"
    }
  }
}

​
Available Filters

FilterInput TypeOperatorsDescription
mapping_group_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledParent mapping group ID
carrier_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledInternal carrier ID
carrier_service_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledInternal carrier service ID
integration_carrier_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledExternal entity ID
integration_carrier_codeStringInputTypeeq, ilike, like, in, betweenExternal entity code
created_atDatetimeInputTypeeq, from, to, betweenCreation timestamp
More fields and filters available via GraphQL introspection.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Body

application/json
​
query
string<textarea>
required

GraphQL query string

Example:

"query($filter: IntegrationCarrierMappingFilterType) { integration_carrier_mappings { all(filter: $filter) { edges { node { id carrier { id } carrier_service { id } integration_carrier { id code } mapping_fields mapping_group_id } } } } }"

​
variables
object

Query variables including the filter object

Example:
{
  "filter": { "mapping_group_id": { "eq": "7" } }
}

Response

Successful GraphQL response

​
data
object

Query result data

​
errors
object[]

GraphQL errors, if any