COcommercetools

GET /{projectKey}

Changed on

The view_audit_log:{projectKey} scope is required, and depending on the resource type queried, their respective scopes must be granted.

If the request exceeds the rate limit, a TooManyRequests error is returned.

Request

  • Base URL
    https://history.europe-west1.gcp.commercetools.com
  • Auth
    OAuth 2
    Client credentials
    Token URLhttps://auth.europe-west1.gcp.commercetools.com/oauth/token
    Scopesview_associate_roles:{projectKey}, view_audit_log:{projectKey}, view_business_units:{projectKey}, view_cart_discounts:{projectKey}, view_categories:{projectKey}, view_customers:{projectKey}, view_customers:{projectKey}:{storeKey}, view_customer_groups:{projectKey}, view_discount_codes:{projectKey}, view_key_value_documents:{projectKey}, view_orders:{projectKey}, view_orders:{projectKey}:{storeKey}, view_payments:{projectKey}, view_products:{projectKey}, view_product_selections:{projectKey}, view_quotes:{projectKey}, view_quote_requests:{projectKey}, view_shipping_methods:{projectKey}, view_shopping_lists:{projectKey}, view_shopping_lists:{projectKey}:{storeKey}, view_staged_quotes:{projectKey}, view_standalone_prices:{projectKey}, view_states:{projectKey}, view_stores:{projectKey}, view_tax_categories:{projectKey}, view_types:{projectKey}
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

resourceTypesChangeHistoryResourceType[]
'now'
OR
string datetime
OR
number double
'now'
OR
string datetime
OR
number double
limitinteger
offsetinteger
userIdstring
userIdsstring[]
clientIdstring
customerIdstring
associateIdstring
businessUnitstring
typestring
resourceIdstring
resourceIdsstring[]
resourceKeystring
source'MerchantCenter' | 'ImpEx' | 'ApiClient'
changesstring[]
storesstring[]
excludePlatformInitiatedChangesPlatformInitiatedChange[]
expandboolean
withTotalboolean

Response

Records of the resource under query.

limitinteger required
countinteger required
totalinteger
offsetinteger required

Changes

  • 0e9494260abbRevision changes
    • info

      added the new optional query request parameter resourceIds

    • info

      added the new optional query request parameter userIds

  • cc3c63466b74Revision changes
    • breaking

      the response property became optional for the status

    • info

      added the new optional query request parameter withTotal