Choose a version:

carrierServiceCreate

mutation

Requires write_shipping access scope.

Creates a carrier service that provides real-time shipping rates to Shopify. Carrier services provide real-time shipping rates from external providers like FedEx, UPS, or custom shipping solutions. The carrier service connects to your external shipping rate calculation system through a callback URL.

When customers reach checkout, Shopify sends order details to your callback URL and displays the returned shipping rates. The service must be active to provide rates during checkout.

Anchor to Arguments

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?

Examples

Create a new CarrierService

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
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/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
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  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 json = await response.json();
  return json.data;
}

Ruby

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)

Node.js

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
        }
    },
  },
});

Response

{
  "carrierServiceCreate": {
    "carrierService": {
      "id": "gid://shopify/DeliveryCarrierService/1036895098",
      "name": "test carrier service",
      "callbackUrl": "https://example.com/",
      "active": true,
      "supportsServiceDiscovery": true
    },
    "userErrors": []
  }
}

carrierServiceCreate reference

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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 json = await response.json();

return json.data;

}

GQL

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

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/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
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  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 json = await response.json();
  return json.data;
}

Node.js

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
        }
    },
  },
});

Ruby

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": []

}