Choose a version:

discountRedeemCodeBulkCreation

query

Returns a bulk code creation resource by ID.

Arguments

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

Was this section helpful?

Anchor to Possible returnsPossible returns

DiscountRedeemCodeBulkCreation

•

DiscountRedeemCodeBulkCreation

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

codes • 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.
codesCount• Int! non-null: The number of codes to create.
createdAt• DateTime! non-null: The date and time when the bulk creation was created.
discountCode• DiscountCodeNode: The code discount associated with the created codes.
done• Boolean! non-null: Whether the bulk creation is still queued (false) or has been run (true).
failedCount• Int! non-null: The number of codes that weren't created successfully.
id• ID! non-null: A globally-unique ID.
importedCount• Int! non-null: The number of codes created successfully.

Was this section helpful?

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

Examples

Open in GraphiQL

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

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

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

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

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

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)

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

}