GraphQLRepositoriesaccountProductPricing
entities.accountProductPricing
Read account product pricing records with the accountProductPricing repository, and change them with the account product pricing mutations. Same records as the REST AccountProductPricings entity.
Queries
Fields of entities { accountProductPricing { … } }.
| Kind | Field | Returns |
|---|---|---|
| QUERY | getById(entityId: ID!)Returns the record with the given id, or null when there is none. Deleted records are returned as well. | AccountProductPricingEntity |
| QUERY | getByIds(entityIds: [ID!]!)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. | [AccountProductPricingEntity!]! |
| QUERY | getAll(limit: Int, offset: Int, filter: AccountProductPricingFilterInput, orderBy: [AccountProductPricingOrderByInput!], includeDeleted: Boolean)Returns the records that match the filter, paged with limit and offset. | [AccountProductPricingEntity!]! |
| QUERY | getByCriteria(filter: AccountProductPricingFilterInput, orderBy: [AccountProductPricingOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)Returns the records that match the filter as a cursor-paginated connection. | AccountProductPricingEntityConnection |
| QUERY | getChangedFieldsSinceRevision(id: UUID!, revision: Int!)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. | [UUID!]! |
Mutations
| Kind | Mutation | Does | Returns |
|---|---|---|---|
| MUTATION | createAccountProductPricing(input: CreateAccountProductPricingInput!, validationLevel: [ValidationLevel!]) | Create one record | CreateAccountProductPricingPayload |
| MUTATION | updateAccountProductPricing(input: UpdateAccountProductPricingInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String) | Update fields | UpdateAccountProductPricingPayload |
| MUTATION | bulkUpdateAccountProductPricing(input: [CreateOrUpdateAccountProductPricingInput!]!, deleteInput: [DeleteAccountProductPricingInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput) | Create or update many; per-item results | BulkUpdateAccountProductPricingPayload |
| MUTATION | deleteAccountProductPricing(input: DeleteAccountProductPricingInput!) | Soft-delete | DeleteAccountProductPricingPayload |
Types
The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.
AccountProductPricingEntity object 14 fields: isDeleteProtected, id, isDeleted, …
Special price of a product for one account, used instead of the regular price when the product is sold to that account.
| Field | Type | Description |
|---|---|---|
isDeleteProtected | Boolean! | True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. |
id | ID! | Unique identifier of entity. |
isDeleted | Boolean | Specifies if the entity is considered deleted. |
modified | DateTime | Last modification time. |
created | DateTime | Creation time. |
account | AccountEntity | Account that this price override applies to. |
currency | CurrencyEntity | Currency of the override price. |
product | ProductEntity | Product whose price is overridden for this account. |
accountId | ID! | Id of the account the price override applies to. |
currencyId | ID! | Id of the currency the override price is expressed in. |
price | Float | Price applied for this product when sold to this account, in the specified currency. |
productId | ID! | Id of the product whose price is overridden for the account. |
revision | Int | Revision when entity was lastly changed. |
instancePermissions | [EntityPermsEnum!]! (1 args) | Permissions the current user has on this record, out of the requested ones. |
AccountProductPricingEntityConnection object pageInfo: PageInfo!, edges: [AccountProductPricingEntityEdge]!, totalCount: Int
Paginated list of AccountProductPricing records.
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo! | Pagination data for this connection. |
edges | [AccountProductPricingEntityEdge]! | Contains the nodes in this connection. |
totalCount | Int | Total number of items in the connection. |
AccountProductPricingEntityEdge object node: AccountProductPricingEntity, cursor: String!
A Relay edge containing a AccountProductPricingEntity and its cursor.
| Field | Type | Description |
|---|---|---|
node | AccountProductPricingEntity | The item at the end of the edge |
cursor | String! | A cursor for use in pagination |
AccountProductPricingFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field
Filter conditions for AccountProductPricing records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.
| Input field | Type | Description |
|---|---|---|
OR | [AccountProductPricingFilterInput!] | Matches records that meet at least one of the listed filters. |
AND | [AccountProductPricingFilterInput!] | Matches records that meet all of the listed filters. |
NOT | AccountProductPricingFilterInput | Matches records that do not meet this filter. |
globalSearchQuery | String | Search term matched against the fields that the global search covers for this entity. |
id | EntityFilterStringField | Unique identifier of entity. |
isDeleted | Boolean | Specifies if the entity is considered deleted. |
modified | EntityFilterDateTimeField | Last modification time. |
created | EntityFilterDateTimeField | Creation time. |
accountId | EntityFilterStringField | Id of the account the price override applies to. |
currencyId | EntityFilterStringField | Id of the currency the override price is expressed in. |
price | EntityFilterNumberField | Price applied for this product when sold to this account, in the specified currency. |
productId | EntityFilterStringField | Id of the product whose price is overridden for the account. |
revision | EntityFilterNumberField | Revision when entity was lastly changed. |
account | AccountFilterInput | Account that this price override applies to. Matches records where a related record meets these conditions. |
currency | CurrencyFilterInput | Currency of the override price. Matches records where a related record meets these conditions. |
product | ProductFilterInput | Product whose price is overridden for this account. Matches records where a related record meets these conditions. |
AccountProductPricingOrderByInput input Asc or Desc per field
Sorting of AccountProductPricing records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.
| Input field | Type | Description |
|---|---|---|
id | OrderByEnum | Unique identifier of entity. |
isDeleted | OrderByEnum | Specifies if the entity is considered deleted. |
modified | OrderByEnum | Last modification time. |
created | OrderByEnum | Creation time. |
account | [AccountOrderByNestedInput!] | Account that this price override applies to. Sorts by fields of the related record, listed in order of priority. |
currency | [CurrencyOrderByNestedInput!] | Currency of the override price. Sorts by fields of the related record, listed in order of priority. |
product | [ProductOrderByNestedInput!] | Product whose price is overridden for this account. Sorts by fields of the related record, listed in order of priority. |
accountId | OrderByEnum | Id of the account the price override applies to. |
currencyId | OrderByEnum | Id of the currency the override price is expressed in. |
price | OrderByEnum | Price applied for this product when sold to this account, in the specified currency. |
productId | OrderByEnum | Id of the product whose price is overridden for the account. |
revision | OrderByEnum | Revision when entity was lastly changed. |
CreateAccountProductPricingInput input 8 fields: clientMutationId, modified, created, …
Field values of a new AccountProductPricing record.
| Input field | Type | Description |
|---|---|---|
clientMutationId | String | Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). |
modified | DateTime | Last modification time. |
created | DateTime | Creation time. |
accountId | ID! | Id of the account the price override applies to. |
currencyId | ID! | Id of the currency the override price is expressed in. |
price | Float | Price applied for this product when sold to this account, in the specified currency. |
productId | ID! | Id of the product whose price is overridden for the account. |
revision | Int | Revision when entity was lastly changed. |
CreateOrUpdateAccountProductPricingInput input 9 fields: clientMutationId, id, modified, …
Field values of an AccountProductPricing record to create, or to update when its id is set.
| Input field | Type | Description |
|---|---|---|
clientMutationId | String | Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). |
id | ID | Unique identifier of entity. |
modified | DateTime | Last modification time. |
created | DateTime | Creation time. |
accountId | ID | Id of the account the price override applies to. |
currencyId | ID | Id of the currency the override price is expressed in. |
price | Float | Price applied for this product when sold to this account, in the specified currency. |
productId | ID | Id of the product whose price is overridden for the account. |
revision | Int | Revision when entity was lastly changed. |
DeleteAccountProductPricingInput input clientMutationId: String, id: ID!
Id of the AccountProductPricing record to delete.
| Input field | Type | Description |
|---|---|---|
clientMutationId | String | Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). |
id | ID! | Unique identifier of entity. |
UpdateAccountProductPricingInput input 9 fields: clientMutationId, id, modified, …
Id of an AccountProductPricing record and the field values to change.
| Input field | Type | Description |
|---|---|---|
clientMutationId | String | Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). |
id | ID! | Unique identifier of entity. |
modified | DateTime | Last modification time. |
created | DateTime | Creation time. |
accountId | ID | Id of the account the price override applies to. |
currencyId | ID | Id of the currency the override price is expressed in. |
price | Float | Price applied for this product when sold to this account, in the specified currency. |
productId | ID | Id of the product whose price is overridden for the account. |
revision | Int | Revision when entity was lastly changed. |
BulkUpdateAccountProductPricingPayload object result: BulkUpdateResults!
Result of the bulkUpdateAccountProductPricing mutation.
| Field | Type | Description |
|---|---|---|
result | BulkUpdateResults! | Ids of the created, updated and deleted records, and the items that failed. |
CreateAccountProductPricingPayload object accountProductPricing: AccountProductPricingEntity, clientMutationId: String
Result of the createAccountProductPricing mutation.
| Field | Type | Description |
|---|---|---|
accountProductPricing | AccountProductPricingEntity | The created record. |
clientMutationId | String | Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). |
DeleteAccountProductPricingPayload object accountProductPricing: AccountProductPricingEntity, clientMutationId: String
Result of the deleteAccountProductPricing mutation.
| Field | Type | Description |
|---|---|---|
accountProductPricing | AccountProductPricingEntity | The deleted record. |
clientMutationId | String | Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). |
UpdateAccountProductPricingPayload object accountProductPricing: AccountProductPricingEntity, clientMutationId: String
Result of the updateAccountProductPricing mutation.
| Field | Type | Description |
|---|---|---|
accountProductPricing | AccountProductPricingEntity | The updated record. |
clientMutationId | String | Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). |