Elastic Path · Example Payload
Elastic Path Examples
Example API request/response patterns extracted from Elastic Path Commerce Cloud API specifications
CommerceHeadless CommerceComposable CommerceeCommerceB2BProductsCatalogsOrdersPromotionsSubscriptionsPayments
Elastic Path Examples is an example object payload from Elastic Path, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
providerdescriptionversionexamples
Example Payload
{
"provider": "Elastic Path",
"description": "Example API request/response patterns extracted from Elastic Path Commerce Cloud API specifications",
"version": "2026-06-13",
"examples": [
{
"id": "get-v2-account-addresses",
"spec": "account-addresses",
"method": "GET",
"path": "/v2/accounts/{accountID}/addresses",
"url": "https://useast.api.elasticpath.com/v2/accounts/{accountID}/addresses",
"summary": "Get Account Addresses",
"tags": [
"Account Addresses"
],
"parameters": [
{
"name": "accountID",
"in": "path",
"required": true,
"description": "The ID of the account you want to retrieve."
},
{
"name": "page[offset]",
"in": "query",
"required": false,
"description": "The number of records to offset the results by."
},
{
"name": "page[limit]",
"in": "query",
"required": false,
"description": "The number of records per page. If not specified, defaults to the `page_length` setting from the Set"
},
{
"name": "page[total_method]",
"in": "query",
"required": false,
"description": "The method used to calculate the total count. `lower_bound` limits expensive count operations, `obse"
},
{
"name": "filter",
"in": "query",
"required": false,
"description": "Filter addresses using a simple query language."
}
]
},
{
"id": "post-v2-account-address",
"spec": "account-addresses",
"method": "POST",
"path": "/v2/accounts/{accountID}/addresses",
"url": "https://useast.api.elasticpath.com/v2/accounts/{accountID}/addresses",
"summary": "Create an Account Address",
"tags": [
"Account Addresses"
],
"parameters": [
{
"name": "accountID",
"in": "path",
"required": true,
"description": "The ID of the account you want to create an address for."
}
]
},
{
"id": "get-v2-account-address",
"spec": "account-addresses",
"method": "GET",
"path": "/v2/accounts/{accountID}/addresses/{addressID}",
"url": "https://useast.api.elasticpath.com/v2/accounts/{accountID}/addresses/{addressID}",
"summary": "Get an Account Address",
"tags": [
"Account Addresses"
],
"parameters": [
{
"name": "accountID",
"in": "path",
"required": true,
"description": "The ID of the account you want to retrieve."
},
{
"name": "addressID",
"in": "path",
"required": true,
"description": "The ID of the address you want to retrieve."
}
]
},
{
"id": "get-v2-accounts",
"spec": "accounts",
"method": "GET",
"path": "/v2/accounts",
"url": "https://useast.api.elasticpath.com/v2/accounts",
"summary": "Get All Accounts",
"tags": [
"Accounts"
],
"parameters": [
{
"name": "sort",
"in": "query",
"required": false,
"description": "Specifies the order in which accounts will be returned. For more information, see [Sorting](/guides/"
}
]
},
{
"id": "post-v2-accounts",
"spec": "accounts",
"method": "POST",
"path": "/v2/accounts",
"url": "https://useast.api.elasticpath.com/v2/accounts",
"summary": "Create an Account",
"tags": [
"Accounts"
],
"parameters": []
},
{
"id": "get-v2-accounts-accountID",
"spec": "accounts",
"method": "GET",
"path": "/v2/accounts/{accountID}",
"url": "https://useast.api.elasticpath.com/v2/accounts/{accountID}",
"summary": "Get an Account",
"tags": [
"Accounts"
],
"parameters": [
{
"name": "accountID",
"in": "path",
"required": true,
"description": "The ID of the account you want to retrieve."
}
]
},
{
"id": "ListApplicationKeys",
"spec": "application-keys",
"method": "GET",
"path": "/v2/application-keys",
"url": "https://useast.api.elasticpath.com/v2/application-keys",
"summary": "List Application Keys",
"tags": [
"Application Keys"
],
"parameters": []
},
{
"id": "CreateAnApplicationKey",
"spec": "application-keys",
"method": "POST",
"path": "/v2/application-keys",
"url": "https://useast.api.elasticpath.com/v2/application-keys",
"summary": "Create an Application Key",
"tags": [
"Application Keys"
],
"parameters": []
},
{
"id": "GetAnApplicationKey",
"spec": "application-keys",
"method": "GET",
"path": "/v2/application-keys/{application-key-id}",
"url": "https://useast.api.elasticpath.com/v2/application-keys/{application-key-id}",
"summary": "Get an Application Key",
"tags": [
"Application Keys"
],
"parameters": []
},
{
"id": "CreateAnAccessToken",
"spec": "authentication",
"method": "POST",
"path": "/oauth/access_token",
"url": "https://useast.api.elasticpath.com/oauth/access_token",
"summary": "Create an Access Token",
"tags": [
"Generate an Access Token"
],
"parameters": []
},
{
"id": "getCarts",
"spec": "carts",
"method": "GET",
"path": "/v2/carts",
"url": "https://useast.api.elasticpath.com/v2/carts",
"summary": "Get Carts",
"tags": [
"Cart Management"
],
"parameters": [
{
"name": "EP-Account-Management-Authentication-Token",
"in": "header",
"required": false,
"description": "An Account Management Authentication token to access a specific account's carts."
},
{
"name": "X-Moltin-Customer-Token",
"in": "header",
"required": false,
"description": "A customer token to access a specific customer's carts."
},
{
"name": "include",
"in": "query",
"required": false,
"description": ""
},
{
"name": "page[limit]",
"in": "query",
"required": false,
"description": "The maximum number of records per page."
},
{
"name": "page[offset]",
"in": "query",
"required": false,
"description": "The number of records to offset the results by."
}
]
},
{
"id": "createACart",
"spec": "carts",
"method": "POST",
"path": "/v2/carts",
"url": "https://useast.api.elasticpath.com/v2/carts",
"summary": "Create a Cart",
"tags": [
"Cart Management"
],
"parameters": [
{
"name": "EP-Account-Management-Authentication-Token",
"in": "header",
"required": false,
"description": "An Account Management Authentication token for the account to be associated with the cart."
},
{
"name": "X-Moltin-Customer-Token",
"in": "header",
"required": false,
"description": "A customer token for the customer to be associated with the cart."
}
]
},
{
"id": "getACart",
"spec": "carts",
"method": "GET",
"path": "/v2/carts/{cartID}",
"url": "https://useast.api.elasticpath.com/v2/carts/{cartID}",
"summary": "Get a Cart",
"tags": [
"Cart Management"
],
"parameters": [
{
"name": "cartID",
"in": "path",
"required": true,
"description": "The unique identifier for this cart that you created."
},
{
"name": "include",
"in": "query",
"required": false,
"description": ""
}
]
},
{
"id": "postMultiSearch",
"spec": "catalog-search",
"method": "POST",
"path": "/pcm/catalog/multi-search",
"url": "https://euwest.api.elasticpath.com/v2/pcm/catalog/multi-search",
"summary": "Multi-search",
"tags": [
"Search"
],
"parameters": []
},
{
"id": "multiSearchByCatalogRelease",
"spec": "catalog-search",
"method": "POST",
"path": "/pcm/catalogs/{catalog_id}/releases/{release_id}/multi-search",
"url": "https://euwest.api.elasticpath.com/v2/pcm/catalogs/{catalog_id}/releases/{release_id}/multi-search",
"summary": "Admin Multi-search",
"tags": [
"Search"
],
"parameters": [
{
"name": "catalog_id",
"in": "path",
"required": true,
"description": "The ID of the catalog to query"
},
{
"name": "release_id",
"in": "path",
"required": true,
"description": "The unique ID of a published release of the catalog or `latestPublished` for the most recently publi"
}
]
},
{
"id": "searchByContext",
"spec": "catalog-search",
"method": "GET",
"path": "/pcm/catalog/search",
"url": "https://euwest.api.elasticpath.com/v2/pcm/catalog/search",
"summary": "Search",
"tags": [
"Search"
],
"parameters": []
},
{
"id": "getByContextRelease",
"spec": "catalog",
"method": "GET",
"path": "/catalog",
"url": "https://euwest.api.elasticpath.com/catalog",
"summary": "Get the catalog release as shoppers",
"tags": [
"Releases"
],
"parameters": []
},
{
"id": "getByContextAllHierarchies",
"spec": "catalog",
"method": "GET",
"path": "/catalog/hierarchies",
"url": "https://euwest.api.elasticpath.com/catalog/hierarchies",
"summary": "Get all Hierarchies",
"tags": [
"Shopper Catalog API"
],
"parameters": []
},
{
"id": "getByContextHierarchy",
"spec": "catalog",
"method": "GET",
"path": "/catalog/hierarchies/{hierarchy_id}",
"url": "https://euwest.api.elasticpath.com/catalog/hierarchies/{hierarchy_id}",
"summary": "Get a Hierarchy",
"tags": [
"Shopper Catalog API"
],
"parameters": [
{
"name": "hierarchy_id",
"in": "path",
"required": true,
"description": "The catalog hierarchy ID."
}
]
},
{
"id": "ListCustomAPIs",
"spec": "commerce-extensions",
"method": "GET",
"path": "/v2/settings/extensions/custom-apis",
"url": "https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis",
"summary": "List Custom APIs",
"tags": [
"Custom APIs"
],
"parameters": []
},
{
"id": "CreateACustomAPI",
"spec": "commerce-extensions",
"method": "POST",
"path": "/v2/settings/extensions/custom-apis",
"url": "https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis",
"summary": "Create a Custom API",
"tags": [
"Custom APIs"
],
"parameters": []
},
{
"id": "GetACustomApi",
"spec": "commerce-extensions",
"method": "GET",
"path": "/v2/settings/extensions/custom-apis/{custom-api-id}",
"url": "https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis/{custom-api-id}",
"summary": "Get a Custom API",
"tags": [
"Custom APIs"
],
"parameters": []
},
{
"id": "getAllCurrencies",
"spec": "currencies",
"method": "GET",
"path": "/v2/currencies",
"url": "https://useast.api.elasticpath.com/v2/currencies",
"summary": "Get all Currencies",
"tags": [
"Currencies"
],
"parameters": [
{
"name": "page[offset]",
"in": "query",
"required": false,
"description": "The number of records to offset the results by."
},
{
"name": "page[limit]",
"in": "query",
"required": false,
"description": "The number of records per page."
}
]
},
{
"id": "createACurrency",
"spec": "currencies",
"method": "POST",
"path": "/v2/currencies",
"url": "https://useast.api.elasticpath.com/v2/currencies",
"summary": "Create a Currency",
"tags": [
"Currencies"
],
"parameters": []
},
{
"id": "getACurrency",
"spec": "currencies",
"method": "GET",
"path": "/v2/currencies/{currencyID}",
"url": "https://useast.api.elasticpath.com/v2/currencies/{currencyID}",
"summary": "Get a Currency",
"tags": [
"Currencies"
],
"parameters": [
{
"name": "currencyID",
"in": "path",
"required": true,
"description": "The ID for the requested currency."
}
]
},
{
"id": "get-v2-customer-addresses",
"spec": "customer-addresses",
"method": "GET",
"path": "/v2/customers/{customerID}/addresses",
"url": "https://useast.api.elasticpath.com/v2/customers/{customerID}/addresses",
"summary": "Get Customer Addresses",
"tags": [
"Customer Addresses"
],
"parameters": [
{
"name": "customerID",
"in": "path",
"required": true,
"description": "The ID of the customer you want to retrieve."
},
{
"name": "page[offset]",
"in": "query",
"required": false,
"description": "The number of records to offset the results by."
},
{
"name": "page[limit]",
"in": "query",
"required": false,
"description": "The number of records per page. If not specified, defaults to the `page_length` setting from the Set"
},
{
"name": "page[total_method]",
"in": "query",
"required": false,
"description": "The method used to calculate the total count. `lower_bound` limits expensive count operations, `obse"
},
{
"name": "filter",
"in": "query",
"required": false,
"description": "Filter addresses using a simple query language."
}
]
},
{
"id": "post-v2-customer-address",
"spec": "customer-addresses",
"method": "POST",
"path": "/v2/customers/{customerID}/addresses",
"url": "https://useast.api.elasticpath.com/v2/customers/{customerID}/addresses",
"summary": "Create a Customer Address",
"tags": [
"Customer Addresses"
],
"parameters": [
{
"name": "customerID",
"in": "path",
"required": true,
"description": "The ID of the customer you want to create an address for."
}
]
},
{
"id": "get-v2-customer-address",
"spec": "customer-addresses",
"method": "GET",
"path": "/v2/customers/{customerID}/addresses/{addressID}",
"url": "https://useast.api.elasticpath.com/v2/customers/{customerID}/addresses/{addressID}",
"summary": "Get an Customer Address",
"tags": [
"Customer Addresses"
],
"parameters": [
{
"name": "customerID",
"in": "path",
"required": true,
"description": "The ID of the customer you want to retrieve."
},
{
"name": "addressID",
"in": "path",
"required": true,
"description": "The ID of the address you want to retrieve."
}
]
},
{
"id": "getMultipleJobs",
"spec": "exporter",
"method": "GET",
"path": "/v2/jobs",
"url": "https://api.moltin.com/v2/jobs",
"summary": "Get All Jobs",
"tags": [
"Jobs"
],
"parameters": []
},
{
"id": "createJob",
"spec": "exporter",
"method": "POST",
"path": "/v2/jobs",
"url": "https://api.moltin.com/v2/jobs",
"summary": "Create Job",
"tags": [
"Jobs"
],
"parameters": []
},
{
"id": "getAJob",
"spec": "exporter",
"method": "GET",
"path": "/v2/jobs/{jobID}",
"url": "https://api.moltin.com/v2/jobs/{jobID}",
"summary": "Get a Job",
"tags": [
"Jobs"
],
"parameters": [
{
"name": "jobID",
"in": "path",
"required": true,
"description": "The unique identifier of the requested job."
}
]
},
{
"id": "getAllFiles",
"spec": "files",
"method": "GET",
"path": "/v2/files",
"url": "https://euwest.api.elasticpath.com/v2/files",
"summary": "Get all Files",
"tags": [
"Files"
],
"parameters": []
},
{
"id": "createAFile",
"spec": "files",
"method": "POST",
"path": "/v2/files",
"url": "https://euwest.api.elasticpath.com/v2/files",
"summary": "Create a File",
"tags": [
"Files"
],
"parameters": []
},
{
"id": "getAFile",
"spec": "files",
"method": "GET",
"path": "/v2/files/{fileID}",
"url": "https://euwest.api.elasticpath.com/v2/files/{fileID}",
"summary": "Get a File",
"tags": [
"Files"
],
"parameters": [
{
"name": "fileID",
"in": "path",
"required": true,
"description": "The unique identifier for a file."
}
]
},
{
"id": "getAllFlows",
"spec": "flows",
"method": "GET",
"path": "/v2/flows",
"url": "https://euwest.api.elasticpath.com/v2/flows",
"summary": "Get all Flows",
"tags": [
"Flows"
],
"parameters": []
},
{
"id": "createAFlow",
"spec": "flows",
"method": "POST",
"path": "/v2/flows",
"url": "https://euwest.api.elasticpath.com/v2/flows",
"summary": "Create a Flow",
"tags": [
"Flows"
],
"parameters": []
},
{
"id": "getAFlow",
"spec": "flows",
"method": "GET",
"path": "/v2/flows/{flowID}",
"url": "https://euwest.api.elasticpath.com/v2/flows/{flowID}",
"summary": "Get a Flow",
"tags": [
"Flows"
],
"parameters": [
{
"name": "flowID",
"in": "path",
"required": true,
"description": "The unique identifier of the flow/template you want to retrieve."
}
]
},
{
"id": "ListIntegrations",
"spec": "integrations",
"method": "GET",
"path": "/integrations",
"url": "https://euwest.api.elasticpath.com/v2/integrations",
"summary": "List integrations",
"tags": [
"Integrations"
],
"parameters": []
},
{
"id": "CreateIntegration",
"spec": "integrations",
"method": "POST",
"path": "/integrations",
"url": "https://euwest.api.elasticpath.com/v2/integrations",
"summary": "Create an integration",
"tags": [
"Integrations"
],
"parameters": []
},
{
"id": "GetIntegration",
"spec": "integrations",
"method": "GET",
"path": "/integrations/{integration_uuid}",
"url": "https://euwest.api.elasticpath.com/v2/integrations/{integration_uuid}",
"summary": "Get an integration",
"tags": [
"Integrations"
],
"parameters": []
},
{
"id": "GetStockForAllProducts",
"spec": "inventory-legacy",
"method": "GET",
"path": "/inventories",
"url": "https://euwest.api.elasticpath.com/v2/inventories",
"summary": "Get Stock for all Products",
"tags": [
"Inventory"
],
"parameters": []
},
{
"id": "GetStockForMultipleProducts",
"spec": "inventory-legacy",
"method": "POST",
"path": "/inventories/multiple",
"url": "https://euwest.api.elasticpath.com/v2/inventories/multiple",
"summary": "Get Stock for Multiple Products",
"tags": [
"Inventory"
],
"parameters": []
},
{
"id": "GetProductStock",
"spec": "inventory-legacy",
"method": "GET",
"path": "/inventories/{product_uuid}",
"url": "https://euwest.api.elasticpath.com/v2/inventories/{product_uuid}",
"summary": "Get Stock for Product",
"tags": [
"Inventory"
],
"parameters": []
},
{
"id": "ListStock",
"spec": "inventory",
"method": "GET",
"path": "/inventories",
"url": "https://euwest.api.elasticpath.com/v2/inventories",
"summary": "Get Stock for all Products",
"tags": [
"Inventory"
],
"parameters": []
},
{
"id": "CreateStock",
"spec": "inventory",
"method": "POST",
"path": "/inventories",
"url": "https://euwest.api.elasticpath.com/v2/inventories",
"summary": "Create Stock for Product",
"tags": [
"Inventory"
],
"parameters": []
},
{
"id": "GetStockForProducts",
"spec": "inventory",
"method": "POST",
"path": "/inventories/multiple",
"url": "https://euwest.api.elasticpath.com/v2/inventories/multiple",
"summary": "List Stock",
"tags": [
"Inventory"
],
"parameters": []
},
{
"id": "getMerchantRealmMappings",
"spec": "merchant-realm-mappings",
"method": "GET",
"path": "/v2/merchant-realm-mappings",
"url": "https://useast.api.elasticpath.com/v2/merchant-realm-mappings",
"summary": "Get the Merchant Realm Mapping for the current store",
"tags": [],
"parameters": []
},
{
"id": "getMerchantRealmMapping",
"spec": "merchant-realm-mappings",
"method": "GET",
"path": "/v2/merchant-realm-mappings/{mapping_id}",
"url": "https://useast.api.elasticpath.com/v2/merchant-realm-mappings/{mapping_id}",
"summary": "Get a Merchant Realm Mapping",
"tags": [],
"parameters": [
{
"name": "mapping_id",
"in": "path",
"required": true,
"description": "The id of the Application Key."
}
]
},
{
"id": "getAllGateways",
"spec": "payments",
"method": "GET",
"path": "/v2/gateways",
"url": "https://useast.api.elasticpath.com/v2/gateways",
"summary": "Get all Gateways",
"tags": [
"Gateways"
],
"parameters": []
},
{
"id": "getAGateway",
"spec": "payments",
"method": "GET",
"path": "/v2/gateways/{gatewaySlug}",
"url": "https://useast.api.elasticpath.com/v2/gateways/{gatewaySlug}",
"summary": "Get a Gateway",
"tags": [
"Gateways"
],
"parameters": [
{
"name": "gatewaySlug",
"in": "path",
"required": true,
"description": "The slug of the gateway."
}
]
},
{
"id": "ListStandardUserRoles",
"spec": "permissions",
"method": "GET",
"path": "/v2/permissions/standard-user-roles",
"url": "https://useast.api.elasticpath.com/v2/permissions/standard-user-roles",
"summary": "List Standard User Roles",
"tags": [
"Standard User Roles"
],
"parameters": []
},
{
"id": "GetAStandardUserRole",
"spec": "permissions",
"method": "GET",
"path": "/v2/permissions/standard-user-roles/{standard-user-role-id}",
"url": "https://useast.api.elasticpath.com/v2/permissions/standard-user-roles/{standard-user-role-id}",
"summary": "Get a Standard User Role",
"tags": [
"Standard User Roles"
],
"parameters": []
},
{
"id": "ListStandardShopperRoles",
"spec": "permissions",
"method": "GET",
"path": "/v2/permissions/standard-shopper-roles",
"url": "https://useast.api.elasticpath.com/v2/permissions/standard-shopper-roles",
"summary": "List Standard Shopper Roles",
"tags": [
"Standard Shopper Roles"
],
"parameters": []
},
{
"id": "get-personal-data-logs",
"spec": "personal-data",
"method": "GET",
"path": "/v2/personal-data/logs",
"url": "https://useast.api.elasticpath.com/v2/personal-data/logs",
"summary": "Get Personal Data Logs",
"tags": [
"Personal Data Logs"
],
"parameters": []
},
{
"id": "get-related-data-entries",
"spec": "personal-data",
"method": "GET",
"path": "/v2/personal-data/related-data-entries",
"url": "https://useast.api.elasticpath.com/v2/personal-data/related-data-entries",
"summary": "Get Personal Data Related Data Entries",
"tags": [
"Personal Data Related Data Entries"
],
"parameters": []
},
{
"id": "get-erasure-requests",
"spec": "personal-data",
"method": "GET",
"path": "/v2/personal-data/erasure-requests",
"url": "https://useast.api.elasticpath.com/v2/personal-data/erasure-requests",
"summary": "Get all Personal Data Erasure Request",
"tags": [
"Personal Data Erasure Requests"
],
"parameters": []
},
{
"id": "getAllJobs",
"spec": "pim",
"method": "GET",
"path": "/pcm/jobs",
"url": "https://euwest.api.elasticpath.com/pcm/jobs",
"summary": "Get All Jobs",
"tags": [
"Jobs"
],
"parameters": []
},
{
"id": "getJob",
"spec": "pim",
"method": "GET",
"path": "/pcm/jobs/{jobID}",
"url": "https://euwest.api.elasticpath.com/pcm/jobs/{jobID}",
"summary": "Get a Job",
"tags": [
"Jobs"
],
"parameters": []
},
{
"id": "cancelJob",
"spec": "pim",
"method": "POST",
"path": "/pcm/jobs/{jobID}/cancel",
"url": "https://euwest.api.elasticpath.com/pcm/jobs/{jobID}/cancel",
"summary": "Cancel a Job",
"tags": [
"Jobs"
],
"parameters": []
},
{
"id": "getPricebooks",
"spec": "pricebooks",
"method": "GET",
"path": "/pcm/pricebooks",
"url": "https://euwest.api.elasticpath.com/pcm/pricebooks",
"summary": "Get all Price Books",
"tags": [
"Price Books"
],
"parameters": []
},
{
"id": "createPricebook",
"spec": "pricebooks",
"method": "POST",
"path": "/pcm/pricebooks",
"url": "https://euwest.api.elasticpath.com/pcm/pricebooks",
"summary": "Create a Price Book",
"tags": [
"Price Books"
],
"parameters": []
},
{
"id": "getPricebookById",
"spec": "pricebooks",
"method": "GET",
"path": "/pcm/pricebooks/{pricebookID}",
"url": "https://euwest.api.elasticpath.com/pcm/pricebooks/{pricebookID}",
"summary": "Get a Price Book by ID",
"tags": [
"Price Books"
],
"parameters": [
{
"name": "include",
"in": "query",
"required": false,
"description": "To include product prices in a response, add `include=prices`."
}
]
},
{
"id": "getRulePromotions",
"spec": "promotions-builder",
"method": "GET",
"path": "/v2/rule-promotions",
"url": "https://useast.api.elasticpath.com/v2/rule-promotions",
"summary": "Get Rule Promotions",
"tags": [
"Rule Promotions"
],
"parameters": [
{
"name": "filter",
"in": "query",
"required": false,
"description": "This parameter accepts a filtering expression that uses specific operators and attributes. \n\n\nThe f"
}
]
},
{
"id": "createRulePromotion",
"spec": "promotions-builder",
"method": "POST",
"path": "/v2/rule-promotions",
"url": "https://useast.api.elasticpath.com/v2/rule-promotions",
"summary": "Create a Rule Promotion",
"tags": [
"Rule Promotions"
],
"parameters": []
},
{
"id": "getRulePromotionById",
"spec": "promotions-builder",
"method": "GET",
"path": "/v2/rule-promotions/{promotionID}",
"url": "https://useast.api.elasticpath.com/v2/rule-promotions/{promotionID}",
"summary": "Get a Rule Promotion by ID",
"tags": [
"Rule Promotions"
],
"parameters": [
{
"name": "promotionID",
"in": "path",
"required": true,
"description": "The unique identifier of the rule promotion."
}
]
},
{
"id": "getAllPromotions",
"spec": "promotions",
"method": "GET",
"path": "/v2/promotions",
"url": "https://useast.api.elasticpath.com/v2/promotions",
"summary": "Get all Promotions",
"tags": [
"Promotions Standard"
],
"parameters": [
{
"name": "page[offset]",
"in": "query",
"required": false,
"description": "The number of records to offset the results by."
},
{
"name": "page[limit]",
"in": "query",
"required": false,
"description": "The number of records per page."
}
]
},
{
"id": "createAPromotion",
"spec": "promotions",
"method": "POST",
"path": "/v2/promotions",
"url": "https://useast.api.elasticpath.com/v2/promotions",
"summary": "Create a Promotion",
"tags": [
"Promotions Standard"
],
"parameters": []
},
{
"id": "getAPromotion",
"spec": "promotions",
"method": "GET",
"path": "/v2/promotions/{promotionID}",
"url": "https://useast.api.elasticpath.com/v2/promotions/{promotionID}",
"summary": "Get a Promotion",
"tags": [
"Promotions Standard"
],
"parameters": [
{
"name": "promotionID",
"in": "path",
"required": true,
"description": "The ID of the promotion."
}
]
},
{
"id": "get-v2-settings",
"spec": "settings",
"method": "GET",
"path": "/v2/settings",
"url": "https://useast.api.elasticpath.com/v2/settings",
"summary": "Get Project Settings",
"tags": [
"Settings"
],
"parameters": []
},
{
"id": "get-oidc-idp-login-stores-storeId-authentication-realms-realmId",
"spec": "single-sign-on",
"method": "GET",
"path": "/oidc-idp/login/stores/{storeId}/authentication-realms/{realmId}",
"url": "https://useast.api.elasticpath.com/oidc-idp/login/stores/{storeId}/authentication-realms/{realmId}",
"summary": "Initiate OIDC Login",
"tags": [
"OIDC Authentication"
],
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The ID of the store."
},
{
"name": "realmId",
"in": "path",
"required": true,
"description": "The ID of the authentication realm."
},
{
"name": "client_id",
"in": "query",
"required": true,
"description": "The Client ID, for Account Management Authentication see the `meta.client_id` field on [Account Auth"
},
{
"name": "redirect_uri",
"in": "query",
"required": true,
"description": "Redirection URI to which the response will be sent. Must exactly match a pre-registered redirect URI"
},
{
"name": "response_type",
"in": "query",
"required": true,
"description": "OIDC/OAuth 2.0 response type, this must be \"code\" in Commerce."
}
]
},
{
"id": "get-oidc-idp-stores-storeId-authentication-realms-realmId-well-known-openid-configuration",
"spec": "single-sign-on",
"method": "GET",
"path": "/oidc-idp/stores/{storeId}/authentication-realms/{realmId}/.well-known/openid-configuration",
"url": "https://useast.api.
# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elastic-path/refs/heads/main/examples/elastic-path-examples.json