priceListCreate

Graphql fields and variables for the priceListCreate mutation

Create a price list

Scope required: product:write

For a complete list of input attributes see the PriceListAttributes type

mutation priceListCreate ($attributes: PriceListAttributes!) {
  priceListCreate (attributes: $attributes) {
      errors
      priceList {
        basePrice
        code
        createdAt
        currencyId
        id
        isVisible
        monthlyBasePrice
        name
        periodMonths
        planId
        priceAdjustmentPercentage
        priceDescription
        productId
        renewalTermMonths
        showPriceAsMonthly
        sku
        trialAllowed
        trialLengthDays
        updatedAt
      }
  }
}

Arguments

{
  "attributes": {
    "planId": "456123",
    "code": "",
    "name": "",
    "sku": "",
    "currencyId": "456123",
    "isVisible": true,
    "trialAllowed": true,
    "trialLengthDays": 123,
    "trialExpirationAction": "TrialExpirationAction",
    "renewalTermMonths": 123,
    "priceAdjustmentAction": "PriceAdjustmentAction",
    "priceAdjustmentTiming": "PriceAdjustmentTiming",
    "priceAdjustmentPercentage": "1.00",
    "showPriceAsMonthly": true
  }
}

Name	Type	Description
attributes	PriceListAttributes

Response

Name	Type	Description
errors	List (String)
priceList	PriceList