updateSalesPolicy

Requires at least one of the permissions settings:sales:update or settings:tenant:update.

Sets the highest discount percentage a manual price override may imply; 100 means no ceiling. Needs settings:sales:update, or settings:tenant:update.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation UpdateSalesPolicy($input: UpdateSalesPolicyInput!) {
  updateSalesPolicy(input: $input) {
    maxDiscountPercent
    requireInvoiceBeforeShip
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation UpdateSalesPolicy($input: UpdateSalesPolicyInput!) {\n  updateSalesPolicy(input: $input) {\n    maxDiscountPercent\n    requireInvoiceBeforeShip\n  }\n}",
  "variables": {
    "input": {
      "maxDiscountPercent": 0
    }
  }
}
EOF

Variables:

{
  "input": {
    "maxDiscountPercent": 0
  }
}

Response:

{
  "data": {
    "updateSalesPolicy": {
      "maxDiscountPercent": 0,
      "requireInvoiceBeforeShip": true
    }
  }
}

updateSalesPolicy(
  input: UpdateSalesPolicyInput!
): SalesPolicy!

Arguments

updateSalesPolicy.input ● UpdateSalesPolicyInput! non-null input

The new discount ceiling.

Type

SalesPolicy object

The organization-wide sales policy.