CommerceOps API actions
CommerceOps API actions are described in this section. For descriptions related to the CommerceShops API and CommerceAuthoring API, see the Commerce Developer's Reference.
Action - CleanEnvironment | Completely removes all artifacts from a Commerce Environment. The environment to clean is passed as a Header called "Environment". Passing in an empty Environment completely clears the global environment, which is where metadata for all the environments is stored. Parameters: Sample: |
Action - InitialzeEnvironment | Initializes a specified Commerce Environment from an empty EntityStore, and adds any needed artifacts. Adds any artifacts needed for a specific Commerce Environment Parameters: Environment – the name of the Commerce Environment to initialize (string) Sample: |
Action - GetEnvironment | Retrieves a single named Commerce Environment. Parameters: Environment – the name of the Commerce Environment to initialize (string) Sample: |
Action - ImportEnvironment | Imports a Commerce Environment from a raw exported environment JSON string. This imports and initializes the metadata for the specified Environment only. Parameters: Environment – the name of the Commerce Environment to initialize (string) Sample: |
Action - ExportEnvironment | Exports a Commerce Environment to JSON. Parameters: Environment – the name of the Commerce Environment to initialize (string) Sample: |
Action - ListEnvironments | Retrieves a list of all known Commerce Environments. Sample: |
Action - GetApiRoutes | Retrieves a list of the current API routes. Sample: |
Action - Bootstrap | Bootstraps the global Commerce Environment from a new empty one. This adds any artifacts that should be created from a freshly installed system. Sample: |