Skip to main content

RegisterCarrierMappingInput

Autogenerated input type of RegisterCarrierMapping

input RegisterCarrierMappingInput {
  carrierId: ID!
  clientCode: String!
  clientMutationId: String
  integrationId: ID
  integrationType: IntegrationTypeEnum!
}

Fields​

RegisterCarrierMappingInput.carrierId ● ID! non-null scalar​

The ID of the carrier in our system.

RegisterCarrierMappingInput.clientCode ● String! non-null scalar​

The code for the carrier in the external system. For instance, 'ups' or 'fedex'.

RegisterCarrierMappingInput.clientMutationId ● String scalar​

A unique identifier for the client performing the mutation.

RegisterCarrierMappingInput.integrationId ● ID scalar​

The ID of the integration that will use this mapping. If not provided, the mapping will be for all integrations that has access to the carrier.

Generally, carrier mappings are created to attend a specific integration, so this argument should be provided.

RegisterCarrierMappingInput.integrationType ● IntegrationTypeEnum! non-null enum​

The type of the integration that will use this mapping. For instance, 'SHOPIFY' or 'SHIPSTATION'.

Member Of​

registerCarrierMapping mutation