epx <command> --help.
Command-line client for the Emporix Commerce APIs.
Credentials are read from the environment:
epx profile add) gives them, its client secret from the
OS keychain: the profile that --profile names, else EPX_PROFILE, else the default profile (epx profile use). The two never mix, and naming a profile while one is set is a usage error.
--tenant overrides the tenant of either. A profile’s default site and language apply where a
command needs a site or shows translations and the flag is not given, on the profile’s tenant.
Exit codes: 0 success, 1 error, 2 invalid usage or configuration,
3 authentication or missing scopes, 4 not found, 5 conflict: a write that Emporix answered with
409 Conflict, as when the item changed since it was read or exists already, or a units update
or catalogs patch with metadata.version answered with 404 Not Found, as the Unit and Catalog
services answer a stale version. A 403 Forbidden that the help of a command calls a refusal
of its input exits 1.
Global flags
Every command takes these flags.-h, --help
Help for epx.--profile <name>
Profile to use (default from EPX_PROFILE, else the default profile).--tenant <string>
Emporix tenant (default from EMPORIX_TENANT, else the profile).--timeout <duration>
Timeout for each HTTP request. Default:30s.
Commands
epx ai
Read and change AI agents and their setup, chat with them, generate texts.epx api
Send requests to any Emporix API path.epx auth
Check Emporix credentials.epx availability
Read and change availability.epx brands
Read, create, change and delete brands.epx carts
Read and change carts and their items and discounts.epx catalogs
Read and change catalogs.epx categories
Read and change categories and the products assigned to them.epx category-trees
Read and rebuild category trees.epx changelog
Read the change history (audit log).epx completion
Generate the autocompletion script for the specified shell.epx configurations
Read and change tenant configurations.epx contact-assignments
Read and change which customers are contacts of which legal entities.epx countries
Read countries, and activate or deactivate them.epx coupons
Read, create, change and redeem coupons.epx currencies
Read, create, change and delete currencies.epx custom-entities
Read and change custom entity types and their instances.epx customer-locations
Read and change the locations of B2B customers.epx customers
Read and change customers and their addresses.epx delivery-times
Read and change delivery times and their time slots; read the delivery windows of a cart.epx exchange-rates
Read, create, change and delete currency exchange rates.epx fees
Read and change fees and which items have them.epx iam
Read and change IAM users, groups and access rights.epx imports
Read import configurations, runs and imported records; start and schedule runs.epx indexing
Read and configure search index providers; reindex.epx invoice-jobs
Create and read invoice jobs.epx labels
Read, create, change and delete labels.epx legal-entities
Read and change legal entities (B2B companies); read their parents.epx media
Read, upload, link and change media assets.epx orders
Read, create and change orders and their status.epx payment-modes
Read, create, update and delete payment modes.epx payment-transactions
Read payment transactions; authorize, capture, refund and cancel payments.epx price-lists
Read and change price lists and their prices.epx price-models
Read and change price models.epx prices
Read and change prices.epx product-templates
Read, create, update and delete product templates.epx products
Read, create, update and delete products.epx profile
Manage profiles: named settings and credentials of a tenant.epx quotes
Read, create and change quotes, their PDF, history and reasons.epx regions
Read regions.epx returns
Read, create, change and delete returns.epx reward-points
Read and change reward points and the ways to redeem them.epx schemas
Read, create, change and delete custom schemas and schema references.epx search
Search documents; read and change search indexes and saved searches.epx segments
Read and change customer segments and what is assigned to them.epx sequential-ids
Read, create, activate and delete sequential ID schemas; issue IDs.epx session-contexts
Read and change session contexts.epx shipping
Read and change shipping zones, methods and groups, and calculate shipping fees.epx shopping-lists
Read, create, replace and delete customers’ shopping lists.epx sites
Read, create and change sites and their mixins.epx taxes
Read and change tax configurations, and calculate net and gross prices.epx units
Read and change units of measurement; read unit types and convert between units.epx vendor-locations
Read and change the locations of vendors.epx vendors
Read and change vendors.epx version
Print the epx version.epx webhooks
Read and change webhook configurations and subscriptions; read statistics.