priceListUpdate

mutation

Requires write_products access scope. Also: The user must have permission to create and edit catalogs.

Updates a price list. If you modify the currency, then any fixed prices set on the price list will be deleted.

Arguments

Anchor to idid • ID!required: The ID of the price list to update.
Anchor to inputinput • PriceListUpdateInput!required: The input data used to update the price list.

Was this section helpful?

Anchor to PriceListUpdatePayload returnsPriceListUpdatePayload returns

Anchor to priceListpriceList • PriceList: The updated price list.
Anchor to userErrorsuserErrors • [PriceListUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Update a price list
priceListUpdate reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation priceListUpdate($id: ID!, $input: PriceListUpdateInput!) {
6    priceListUpdate(id: $id, input: $input) {
7      priceList {
8        id
9        parent {
10          adjustment {
11            type
12            value
13          }
14        }
15      }
16      userErrors {
17        message
18        field
19        code
20      }
21    }
22  }`,
23  {
24    variables: {
25      "id": "gid://shopify/PriceList/734173888",
26      "input": {
27        "parent": {
28          "adjustment": {
29            "value": 10,
30            "type": "PERCENTAGE_INCREASE"
31          }
32        }
33      }
34    },
35  },
36);
37
38const data = await response.json();
39

mutation priceListUpdate($id: ID!, $input: PriceListUpdateInput!) {
  priceListUpdate(id: $id, input: $input) {
    priceList {
      id
      parent {
        adjustment {
          type
          value
        }
      }
    }
    userErrors {
      message
      field
      code
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation priceListUpdate($id: ID!, $input: PriceListUpdateInput!) { priceListUpdate(id: $id, input: $input) { priceList { id parent { adjustment { type value } } } userErrors { message field code } } }",
 "variables": {
    "id": "gid://shopify/PriceList/734173888",
    "input": {
      "parent": {
        "adjustment": {
          "value": 10,
          "type": "PERCENTAGE_INCREASE"
        }
      }
    }
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation priceListUpdate($id: ID!, $input: PriceListUpdateInput!) {
    priceListUpdate(id: $id, input: $input) {
      priceList {
        id
        parent {
          adjustment {
            type
            value
          }
        }
      }
      userErrors {
        message
        field
        code
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/PriceList/734173888",
      "input": {
        "parent": {
          "adjustment": {
            "value": 10,
            "type": "PERCENTAGE_INCREASE"
          }
        }
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation priceListUpdate($id: ID!, $input: PriceListUpdateInput!) {
      priceListUpdate(id: $id, input: $input) {
        priceList {
          id
          parent {
            adjustment {
              type
              value
            }
          }
        }
        userErrors {
          message
          field
          code
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/PriceList/734173888",
      "input": {
        "parent": {
          "adjustment": {
            "value": 10,
            "type": "PERCENTAGE_INCREASE"
          }
        }
      }
    },
  },
});

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 priceListUpdate($id: ID!, $input: PriceListUpdateInput!) {
    priceListUpdate(id: $id, input: $input) {
      priceList {
        id
        parent {
          adjustment {
            type
            value
          }
        }
      }
      userErrors {
        message
        field
        code
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/PriceList/734173888",
  "input": {
    "parent": {
      "adjustment": {
        "value": 10,
        "type": "PERCENTAGE_INCREASE"
      }
    }
  }
}

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

Input variables

JSON

1{
2  "id": "gid://shopify/PriceList/734173888",
3  "input": {
4    "parent": {
5      "adjustment": {
6        "value": 10,
7        "type": "PERCENTAGE_INCREASE"
8      }
9    }
10  }
11}

Response

JSON

1{
2  "priceListUpdate": {
3    "priceList": {
4      "id": "gid://shopify/PriceList/734173888",
5      "parent": {
6        "adjustment": {
7          "type": "PERCENTAGE_INCREASE",
8          "value": 10
9        }
10      }
11    },
12    "userErrors": []
13  }
14}