Create Account Group
Beta/v1/sales/account-groupsIdempotent with Idempotency-Key header. Learn more
Creates an account group.
Returns a conflict error if an account group with the same name already exists.
namestringDisplay name of the account group.
Must be unique within your account; maximum 255 characters.
typestringenumValues:pricing_grouptype_groupHow this account group will be used.
pricing_group: used for pricing rules, such as a "Preferred" group that receives a special discount.type_group: used to categorize accounts, such as "Consumers" or "Distributors".
The type cannot be changed after creation.
commission_policyoptional stringenumValues:commission_appliedcommission_exemptHow sales commission applies to accounts in this group. Defaults to commission_exempt.
commission_applied: sales commission is calculated on orders from accounts in this group.commission_exempt: orders from accounts in this group are exempt from commission.
freight_policyoptional stringenumValues:free_freightbilled_freightHow freight charges apply to orders from accounts in this group. Defaults to billed_freight.
free_freight: customers within this group will not have to pay for freight.billed_freight: freight will be applied to any order within this account group, unless overridden elsewhere.
descriptionoptional stringFree-form description of the account group.
idstringAccount group ID.
objectstringenumValues:account_groupResource type identifier.
typestringenumValues:pricing_grouptype_groupHow this account group is used.
pricing_group: used for pricing rules, such as a "Preferred" group that receives a special discount.type_group: used to categorize accounts, such as "Consumers" or "Distributors".
namestringDisplay name of the account group.
Unique within the account.
descriptionstringnullableFree-form description of the account group.
commission_policystringenumValues:commission_appliedcommission_exemptHow sales commission applies to accounts in this group.
commission_applied: sales commission is calculated on orders from accounts in this group.commission_exempt: orders from accounts in this group are exempt from commission.
freight_policystringenumValues:free_freightbilled_freightHow freight charges apply to orders from accounts in this group.
free_freight: customers within this group will not have to pay for freight.billed_freight: freight will be applied to any order within this account group, unless overridden elsewhere.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.
Responses
Successful response for Create Account Group