Company

Fires when the contactRoles field on the Company object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The contactRoles field represents the list of roles for the company contacts.

Variables: companyId, contactRolesId

Fires when the contacts field on the Company object changes.

company.contacts.* is a parent trigger. Subscribing with the "update" action receives events for all supported triggers under company.contacts, including nested triggers. Use a more specific trigger to limit events to the fields you need.

Include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The contacts field represents the list of contacts in the company.

Variables: companyId, contactsId

Fires when the locale field on the CompanyContact object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The locale field represents the company contact's locale (language).

Variables: companyId, contactsId

Fires when the roleAssignments field on the CompanyContact object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The roleAssignments field represents the list of roles assigned to this company contact.

Variables: companyId, contactsId, roleAssignmentsId

Fires when the title field on the CompanyContact object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The title field represents the company contact's job title.

Variables: companyId, contactsId

Fires when the externalId field on the Company object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The externalId field represents a unique externally-supplied ID for the company.

Variables: companyId

Fires when the locations field on the Company object changes.

company.locations.* is a parent trigger. Subscribing with the "update" action receives events for all supported triggers under company.locations, including nested triggers. Use a more specific trigger to limit events to the fields you need.

Include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The locations field represents the list of locations in the company.

Variables: companyId, locationsId

Fires when the billingAddress field on the CompanyLocation object changes.

company.locations.billingAddress.* is a parent trigger. Subscribing with the "update" action receives events for all supported triggers under company.locations.billingAddress, including nested triggers. Use a more specific trigger to limit events to the fields you need.

Include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The billingAddress field represents the address used as billing address for the location.

Variables: companyId, locationsId

Fires when the address1 field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The address1 field represents the first line of the address.

Variables: companyId, locationsId

Fires when the address2 field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The address2 field represents the second line of the address.

Variables: companyId, locationsId

Fires when the city field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The city field represents the name of the city, district, village, or town.

Variables: companyId, locationsId

Fires when the country field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The country field represents the name of the country.

Variables: companyId, locationsId

Fires when the countryCode field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The countryCode field represents the two-letter code for the country of the address.

Variables: companyId, locationsId

Fires when the firstName field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The firstName field represents the first name of the recipient.

Variables: companyId, locationsId

Fires when the lastName field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The lastName field represents the last name of the recipient.

Variables: companyId, locationsId

Fires when the phone field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The phone field represents a unique phone number for the customer.

Variables: companyId, locationsId

Fires when the province field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The province field represents the region of the address, such as the province, state, or district.

Variables: companyId, locationsId

Fires when the recipient field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The recipient field represents the identity of the recipient e.g.

Variables: companyId, locationsId

Fires when the zip field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The zip field represents the zip or postal code of the address.

Variables: companyId, locationsId

Fires when the zoneCode field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The zoneCode field represents the alphanumeric code for the region.

Variables: companyId, locationsId

Fires when the buyerExperienceConfiguration field on the CompanyLocation object changes.

company.locations.buyerExperienceConfiguration.* is a parent trigger. Subscribing with the "update" action receives events for all supported triggers under company.locations.buyerExperienceConfiguration, including nested triggers. Use a more specific trigger to limit events to the fields you need.

Include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The buyerExperienceConfiguration field represents the configuration for the buyer's B2B checkout.

Variables: companyId, locationsId

Fires when the checkoutToDraft field on the BuyerExperienceConfiguration object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The checkoutToDraft field indicates whether to checkout to draft order for merchant review.

Variables: companyId, locationsId

Fires when the deposit field on the BuyerExperienceConfiguration object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The deposit field represents the portion required to be paid at checkout.

Variables: companyId, locationsId

Fires when the editableShippingAddress field on the BuyerExperienceConfiguration object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The editableShippingAddress field indicates whether to allow customers to use editable shipping addresses.

Variables: companyId, locationsId

Fires when the paymentTermsTemplate field on the BuyerExperienceConfiguration object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

Represents the merchant configured payment terms.

Variables: companyId, locationsId

Fires when the currency field on the CompanyLocation object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The currency field represents the location's currency based on the shipping address.

Variables: companyId, locationsId

Fires when the externalId field on the CompanyLocation object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The externalId field represents a unique externally-supplied ID for the company location.

Variables: companyId, locationsId

Fires when the locale field on the CompanyLocation object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The locale field represents the preferred locale of the company location.

Variables: companyId, locationsId

Fires when the name field on the CompanyLocation object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The name field represents the name of the company location.

Variables: companyId, locationsId

Fires when the note field on the CompanyLocation object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The note field represents a note about the company location.

Variables: companyId, locationsId

Fires when the phone field on the CompanyLocation object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The phone field represents the phone number of the company location.

Variables: companyId, locationsId

Fires when the roleAssignments field on the CompanyLocation object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The roleAssignments field represents the list of roles assigned to the company location.

Variables: companyId, locationsId, roleAssignmentsId

Fires when the shippingAddress field on the CompanyLocation object changes.

company.locations.shippingAddress.* is a parent trigger. Subscribing with the "update" action receives events for all supported triggers under company.locations.shippingAddress, including nested triggers. Use a more specific trigger to limit events to the fields you need.

Include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The shippingAddress field represents the address used as shipping address for the location.

Variables: companyId, locationsId

Fires when the address1 field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The address1 field represents the first line of the address.

Variables: companyId, locationsId

Fires when the address2 field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The address2 field represents the second line of the address.

Variables: companyId, locationsId

Fires when the city field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The city field represents the name of the city, district, village, or town.

Variables: companyId, locationsId

Fires when the country field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The country field represents the name of the country.

Variables: companyId, locationsId

Fires when the countryCode field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The countryCode field represents the two-letter code for the country of the address.

Variables: companyId, locationsId

Fires when the firstName field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The firstName field represents the first name of the recipient.

Variables: companyId, locationsId

Fires when the lastName field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The lastName field represents the last name of the recipient.

Variables: companyId, locationsId

Fires when the phone field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The phone field represents a unique phone number for the customer.

Variables: companyId, locationsId

Fires when the province field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The province field represents the region of the address, such as the province, state, or district.

Variables: companyId, locationsId

Fires when the recipient field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The recipient field represents the identity of the recipient e.g.

Variables: companyId, locationsId

Fires when the zip field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The zip field represents the zip or postal code of the address.

Variables: companyId, locationsId

Fires when the zoneCode field on the CompanyAddress object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The zoneCode field represents the alphanumeric code for the region.

Variables: companyId, locationsId

Fires when the mainContact field on the Company object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The mainContact field represents the main contact for the company.

Variables: companyId

Fires when the metafield field on the Company object changes.

company.metafield(namespace: String!, key: String!).* is a parent trigger. Subscribing with the "update" action receives events for all supported triggers under company.metafield(namespace: String!, key: String!), including nested triggers. Use a more specific trigger to limit events to the fields you need.

Include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The metafield field represents a custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Variables: companyId, metafieldKey, metafieldNamespace

Fires when the metafield field on the Company object changes.

company.metafield(namespace: String!).* is a parent trigger. Subscribing with the "update" action receives events for all supported triggers under company.metafield(namespace: String!), including nested triggers. Use a more specific trigger to limit events to the fields you need.

Include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

This subscription omits the optional argument metafield.key.

The metafield field represents a custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Variables: companyId, metafieldKey, metafieldNamespace

Fires when the value field on the Metafield object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The value field represents the data stored in the metafield.

Variables: companyId, metafieldKey, metafieldNamespace

Fires when the value field on the Metafield object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

This subscription omits the optional argument metafield.key.

The value field represents the data stored in the metafield.

Variables: companyId, metafieldKey, metafieldNamespace

Fires when the name field on the Company object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The name field represents the name of the company.

Variables: companyId

Fires when the note field on the Company object changes.

Subscribe to this trigger with the "update" action and include the field in a custom query to retrieve updated data from the payload. You can trace the field in subsequent requests using fields_changed.

The note field represents a note about the company.

Variables: companyId