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

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation CarrierServiceCreate($input: DeliveryCarrierServiceCreateInput!) {
6    carrierServiceCreate(input: $input) {
7      carrierService {
8        id
9        name
10        callbackUrl
11        active
12        supportsServiceDiscovery
13      }
14      userErrors {
15        field
16        message
17      }
18    }
19  }`,
20  {
21    variables: {
22      "input": {
23        "name": "test carrier service",
24        "callbackUrl": "https://example.com/",
25        "supportsServiceDiscovery": true,
26        "active": true
27      }
28    },
29  },
30);
31
32const data = await response.json();
33

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/2024-07/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

1{
2  "input": {
3    "name": "test carrier service",
4    "callbackUrl": "https://example.com/",
5    "supportsServiceDiscovery": true,
6    "active": true
7  }
8}

Response

JSON

1{
2  "carrierServiceCreate": {
3    "carrierService": {
4      "id": "gid://shopify/DeliveryCarrierService/1036895098",
5      "name": "test carrier service",
6      "callbackUrl": "https://example.com/",
7      "active": true,
8      "supportsServiceDiscovery": true
9    },
10    "userErrors": []
11  }
12}