GuidesAPI Reference
Log In
API Reference
Start typing to search…

Multi-store API Key

An API key that allows partners with multiple stores to easily modify their resources via a single key.

A partner managing various stores, such as B2B & B2C or stores in different countries like France & Italy, can streamline integration by utilizing a multi-store API key. This key empowers developers to seamlessly access and modify resources within any combination of their designated stores.

When using a multi-store API key, the targeted store(s) must be specified via:

  • Create resources: requiredstore_id body parameter
  • Retrieve resources: required store_id query parameter when using a non unique externally defined identifier
  • List resources: optional store_id query parameter to filter the resources on a particular store
  • Update resources: required store_id body parameter when using a non unique externally defined identifier
  • Delete resources: required store_id body parameter when using a non unique externally defined identifier

Note that a resource's store_id cannot be modified after creation.