Choose a version:

Anchor to discountRedeemCodeBulkCreation

discountRedeemCodeBulkCreation

query

Returns a DiscountRedeemCodeBulkCreation resource by ID.

Anchor to Arguments

Arguments

Anchor to idid •ID! required: The ID of the DiscountRedeemCodeBulkCreation to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to DiscountRedeemCodeBulkCreationDiscountRedeemCodeBulkCreation

•DiscountRedeemCodeBulkCreation

The properties and status of a bulk discount redeem code creation operation.

Anchor to codescodes

•DiscountRedeemCodeBulkCreationCodeConnection!

non-null

The result of each code creation operation associated with the bulk creation operation including any errors that might have occurred during the operation.

Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to codesCountcodesCount

•Int!

non-null

The number of codes to create.

Anchor to createdAtcreatedAt

•DateTime!

non-null

The date and time when the bulk creation was created.

Anchor to discountCodediscountCode

•DiscountCodeNode

The code discount associated with the created codes.

Anchor to donedone

•Boolean!

non-null

Whether the bulk creation is still queued (false) or has been run (true).

Anchor to failedCountfailedCount

•Int!

non-null

The number of codes that weren't created successfully.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to importedCountimportedCount

•Int!

non-null

The number of codes created successfully.

Was this section helpful?

Examples

Retrieves a discount code creation job

Query

query DiscountRedeemCodeBulkShow($id: ID!) {
  discountRedeemCodeBulkCreation(id: $id) {
    id
    createdAt
    discountCode {
      id
    }
    done
    codesCount
    importedCount
    failedCount
  }
}

Variables

{
  "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355202"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query DiscountRedeemCodeBulkShow($id: ID!) { discountRedeemCodeBulkCreation(id: $id) { id createdAt discountCode { id } done codesCount importedCount failedCount } }",
 "variables": {
    "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355202"
  }
}'

React Router

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

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query DiscountRedeemCodeBulkShow($id: ID!) {
    discountRedeemCodeBulkCreation(id: $id) {
      id
      createdAt
      discountCode {
        id
      }
      done
      codesCount
      importedCount
      failedCount
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355202"
    },
  },
  );
  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
  query DiscountRedeemCodeBulkShow($id: ID!) {
    discountRedeemCodeBulkCreation(id: $id) {
      id
      createdAt
      discountCode {
        id
      }
      done
      codesCount
      importedCount
      failedCount
    }
  }
QUERY

variables = {
  "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355202"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query DiscountRedeemCodeBulkShow($id: ID!) {
      discountRedeemCodeBulkCreation(id: $id) {
        id
        createdAt
        discountCode {
          id
        }
        done
        codesCount
        importedCount
        failedCount
      }
    }`,
    "variables": {
        "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355202"
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'query DiscountRedeemCodeBulkShow($id: ID!) {
  discountRedeemCodeBulkCreation(id: $id) {
    id
    createdAt
    discountCode {
      id
    }
    done
    codesCount
    importedCount
    failedCount
  }
}' \
--variables \
'{
  "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355202"
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query DiscountRedeemCodeBulkShow($id: ID!) {
        discountRedeemCodeBulkCreation(id: $id) {
          id
          createdAt
          discountCode {
            id
          }
          done
          codesCount
          importedCount
          failedCount
        }
      }
    `,
    variables: {
        "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355202"
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "discountRedeemCodeBulkCreation": {
    "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355202",
    "createdAt": "2024-11-06T21:07:10Z",
    "discountCode": {
      "id": "gid://shopify/DiscountCodeNode/2429471"
    },
    "done": true,
    "codesCount": 2,
    "importedCount": 2,
    "failedCount": 1
  }
}

Retrieves a list of discount codes for a discount code creation job

Query

query DiscountRedeemCodeBulkShow($id: ID!) {
  discountRedeemCodeBulkCreation(id: $id) {
    id
    createdAt
    discountCode {
      id
    }
    codes(first: 10) {
      nodes {
        discountRedeemCode {
          code
        }
        errors {
          message
          field
          extraInfo
          code
        }
      }
    }
  }
}

Variables

{
  "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355205"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query DiscountRedeemCodeBulkShow($id: ID!) { discountRedeemCodeBulkCreation(id: $id) { id createdAt discountCode { id } codes(first: 10) { nodes { discountRedeemCode { code } errors { message field extraInfo code } } } } }",
 "variables": {
    "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355205"
  }
}'

React Router

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

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query DiscountRedeemCodeBulkShow($id: ID!) {
    discountRedeemCodeBulkCreation(id: $id) {
      id
      createdAt
      discountCode {
        id
      }
      codes(first: 10) {
        nodes {
          discountRedeemCode {
            code
          }
          errors {
            message
            field
            extraInfo
            code
          }
        }
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355205"
    },
  },
  );
  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
  query DiscountRedeemCodeBulkShow($id: ID!) {
    discountRedeemCodeBulkCreation(id: $id) {
      id
      createdAt
      discountCode {
        id
      }
      codes(first: 10) {
        nodes {
          discountRedeemCode {
            code
          }
          errors {
            message
            field
            extraInfo
            code
          }
        }
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355205"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query DiscountRedeemCodeBulkShow($id: ID!) {
      discountRedeemCodeBulkCreation(id: $id) {
        id
        createdAt
        discountCode {
          id
        }
        codes(first: 10) {
          nodes {
            discountRedeemCode {
              code
            }
            errors {
              message
              field
              extraInfo
              code
            }
          }
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355205"
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'query DiscountRedeemCodeBulkShow($id: ID!) {
  discountRedeemCodeBulkCreation(id: $id) {
    id
    createdAt
    discountCode {
      id
    }
    codes(first: 10) {
      nodes {
        discountRedeemCode {
          code
        }
        errors {
          message
          field
          extraInfo
          code
        }
      }
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355205"
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query DiscountRedeemCodeBulkShow($id: ID!) {
        discountRedeemCodeBulkCreation(id: $id) {
          id
          createdAt
          discountCode {
            id
          }
          codes(first: 10) {
            nodes {
              discountRedeemCode {
                code
              }
              errors {
                message
                field
                extraInfo
                code
              }
            }
          }
        }
      }
    `,
    variables: {
        "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355205"
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "discountRedeemCodeBulkCreation": {
    "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355205",
    "createdAt": "2024-11-06T21:07:11Z",
    "discountCode": {
      "id": "gid://shopify/DiscountCodeNode/2429471"
    },
    "codes": {
      "nodes": [
        {
          "discountRedeemCode": {
            "code": "FOOBAR"
          },
          "errors": []
        },
        {
          "discountRedeemCode": {
            "code": "FOOBAZ"
          },
          "errors": []
        },
        {
          "discountRedeemCode": null,
          "errors": [
            {
              "message": "must be unique. Please try a different code.",
              "field": [
                "code"
              ],
              "extraInfo": null,
              "code": null
            }
          ]
        }
      ]
    }
  }
}

Examples

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

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

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

const response = await admin.graphql(

`#graphql

query DiscountRedeemCodeBulkShow($id: ID!) {

discountRedeemCodeBulkCreation(id: $id) {

createdAt

discountCode {

}

done

codesCount

importedCount

failedCount

}

}`,

{

variables: {

"id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355202"

);

const json = await response.json();

return json.data;

}

GQL

query DiscountRedeemCodeBulkShow($id: ID!) {
  discountRedeemCodeBulkCreation(id: $id) {
    id
    createdAt
    discountCode {
      id
    }
    done
    codesCount
    importedCount
    failedCount
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query DiscountRedeemCodeBulkShow($id: ID!) { discountRedeemCodeBulkCreation(id: $id) { id createdAt discountCode { id } done codesCount importedCount failedCount } }",
 "variables": {
    "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355202"
  }
}'

React Router

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

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query DiscountRedeemCodeBulkShow($id: ID!) {
    discountRedeemCodeBulkCreation(id: $id) {
      id
      createdAt
      discountCode {
        id
      }
      done
      codesCount
      importedCount
      failedCount
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355202"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query DiscountRedeemCodeBulkShow($id: ID!) {
      discountRedeemCodeBulkCreation(id: $id) {
        id
        createdAt
        discountCode {
          id
        }
        done
        codesCount
        importedCount
        failedCount
      }
    }`,
    "variables": {
        "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355202"
    },
  },
});

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
  query DiscountRedeemCodeBulkShow($id: ID!) {
    discountRedeemCodeBulkCreation(id: $id) {
      id
      createdAt
      discountCode {
        id
      }
      done
      codesCount
      importedCount
      failedCount
    }
  }
QUERY

variables = {
  "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355202"
}

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

Shopify CLI

shopify app execute \
--query \
'query DiscountRedeemCodeBulkShow($id: ID!) {
  discountRedeemCodeBulkCreation(id: $id) {
    id
    createdAt
    discountCode {
      id
    }
    done
    codesCount
    importedCount
    failedCount
  }
}' \
--variables \
'{
  "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355202"
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query DiscountRedeemCodeBulkShow($id: ID!) {
        discountRedeemCodeBulkCreation(id: $id) {
          id
          createdAt
          discountCode {
            id
          }
          done
          codesCount
          importedCount
          failedCount
        }
      }
    `,
    variables: {
        "id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355202"
    },
  }),
});

const { data } = await response.json();
console.log(data);

Input variables

JSON

{

"id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355202"

}

Response

JSON

{

"discountRedeemCodeBulkCreation": {

"id": "gid://shopify/DiscountRedeemCodeBulkCreation/989355202",

"createdAt": "2024-11-06T21:07:10Z",

"discountCode": {

"id": "gid://shopify/DiscountCodeNode/2429471"

"done": true,

"codesCount": 2,

"importedCount": 2,

"failedCount": 1

}