Choose a version:

carrierServiceCreate

mutation

Requires write_shipping access scope.

Creates a new carrier service.

Arguments

Anchor to inputinput • DeliveryCarrierServiceCreateInput!required: The input fields used to create a carrier service.

Was this section helpful?

Anchor to CarrierServiceCreatePayload returnsCarrierServiceCreatePayload returns

Anchor to carrierServicecarrierService • DeliveryCarrierService: The created carrier service.
Anchor to userErrorsuserErrors • [CarrierServiceCreateUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Create a new CarrierService
carrierServiceCreate reference

Examples

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation CarrierServiceCreate($input: DeliveryCarrierServiceCreateInput!) {

carrierServiceCreate(input: $input) {

carrierService {

name

callbackUrl

active

supportsServiceDiscovery

}

userErrors {

field

message

}

}`,

{

variables: {

"input": {

"name": "test carrier service",

"callbackUrl": "https://example.com/",

"supportsServiceDiscovery": true,

"active": true

}

);

const data = await response.json();

mutation CarrierServiceCreate($input: DeliveryCarrierServiceCreateInput!) {
  carrierServiceCreate(input: $input) {
    carrierService {
      id
      name
      callbackUrl
      active
      supportsServiceDiscovery
    }
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation CarrierServiceCreate($input: DeliveryCarrierServiceCreateInput!) { carrierServiceCreate(input: $input) { carrierService { id name callbackUrl active supportsServiceDiscovery } userErrors { field message } } }",
 "variables": {
    "input": {
      "name": "test carrier service",
      "callbackUrl": "https://example.com/",
      "supportsServiceDiscovery": true,
      "active": true
    }
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation CarrierServiceCreate($input: DeliveryCarrierServiceCreateInput!) {
    carrierServiceCreate(input: $input) {
      carrierService {
        id
        name
        callbackUrl
        active
        supportsServiceDiscovery
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "input": {
        "name": "test carrier service",
        "callbackUrl": "https://example.com/",
        "supportsServiceDiscovery": true,
        "active": true
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation CarrierServiceCreate($input: DeliveryCarrierServiceCreateInput!) {
      carrierServiceCreate(input: $input) {
        carrierService {
          id
          name
          callbackUrl
          active
          supportsServiceDiscovery
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "input": {
        "name": "test carrier service",
        "callbackUrl": "https://example.com/",
        "supportsServiceDiscovery": true,
        "active": true
      }
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation CarrierServiceCreate($input: DeliveryCarrierServiceCreateInput!) {
    carrierServiceCreate(input: $input) {
      carrierService {
        id
        name
        callbackUrl
        active
        supportsServiceDiscovery
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "name": "test carrier service",
    "callbackUrl": "https://example.com/",
    "supportsServiceDiscovery": true,
    "active": true
  }
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"input": {

"name": "test carrier service",

"callbackUrl": "https://example.com/",

"supportsServiceDiscovery": true,

"active": true

}

Response

JSON

{

"carrierServiceCreate": {

"carrierService": {

"id": "gid://shopify/DeliveryCarrierService/1036895098",

"name": "test carrier service",

"callbackUrl": "https://example.com/",

"active": true,

"supportsServiceDiscovery": true

"userErrors": []

}