# Checkout Applications API The Checkout Applications API lets you create and manage Checkout applications programmatically, giving you full control over your Checkout configurations without manual setup in the Merchant Center. With this API, you can automate the creation of new Checkout applications, update existing configurations, and maintain consistent experiences across multiple Stores, Regions, or Business Units. This API is valuable for managing multiple Checkout instances, enabling you to standardize configurations, deploy changes at scale, and integrate Checkout application management into your existing development workflows. You can create applications with specific settings, update application properties, and ensure your Checkout solutions remain aligned with your business requirements as they evolve. The Checkout Applications API and the [Payment Integrations API](https://docs.commercetools.com/checkout/payment-integrations-api.md) are designed to work together when creating a complete Checkout solution: the Applications API defines the application itself, while the Payment Integrations API configures its payment methods. For updates, you can use each API independently to modify only the specific aspects of your checkout application that need changes. ## Representations #### Application See API type definition [Application](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3AApplication). #### Application Draft See API type definition [ApplicationDraft](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3AApplicationDraft). #### ApplicationLogo See API type definition [ApplicationLogo](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3AApplicationLogo). #### ApplicationStatus See API type definition [ApplicationStatus](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3AApplicationStatus). #### ApplicationAgreementStatus See API type definition [ApplicationAgreementStatus](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3AApplicationAgreementStatus). #### AllowedOrigins See API type definition [AllowedOrigins](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3AAllowedOrigins). #### PaymentsConfiguration See API type definition [PaymentsConfiguration](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3APaymentsConfiguration). #### DiscountsConfiguration See API type definition [DiscountsConfiguration](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3ADiscountsConfiguration). #### Application Agreement See API type definition [ApplicationAgreement](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3AApplicationAgreement). #### Application Agreement Draft See API type definition [ApplicationAgreementDraft](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3AApplicationAgreementDraft). #### Application Mode See API type definition [ApplicationMode](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3AApplicationMode). #### Payment Component Mode See API type definition [PaymentComponentType](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3APaymentComponentType). #### Application Agreement Type See API type definition [ApplicationAgreementType](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3AApplicationAgreementType). #### ApplicationReference See API type definition [ApplicationReference](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3AApplicationReference). #### ApplicationResourceIdentifier See API type definition [ApplicationResourceIdentifier](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3AApplicationResourceIdentifier). ## Get Application ### Get Application by ID See API endpoint definition [GET /\{projectKey}/applications/\{id}](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Aendpoint%3A%2F%7BprojectKey%7D%2Fapplications%2F%7Bid%7D%3AGET). ### Get Application by Key See API endpoint definition [GET /\{projectKey}/applications/key=\{key}](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Aendpoint%3A%2F%7BprojectKey%7D%2Fapplications%2Fkey%3D%7Bkey%7D%3AGET). ## Query Applications See API endpoint definition [GET /\{projectKey}/applications](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Aendpoint%3A%2F%7BprojectKey%7D%2Fapplications%3AGET). ## Check If Application exists ### Check by ID See API endpoint definition [HEAD /\{projectKey}/applications/\{id}](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Aendpoint%3A%2F%7BprojectKey%7D%2Fapplications%2F%7Bid%7D%3AHEAD). ### Check by Key See API endpoint definition [HEAD /\{projectKey}/applications/key=\{key}](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Aendpoint%3A%2F%7BprojectKey%7D%2Fapplications%2Fkey%3D%7Bkey%7D%3AHEAD). ## Create Application See API endpoint definition [POST /\{projectKey}/applications](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Aendpoint%3A%2F%7BprojectKey%7D%2Fapplications%3APOST). ## Update Application ### Update Application by ID See API endpoint definition [POST /\{projectKey}/applications/\{id}](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Aendpoint%3A%2F%7BprojectKey%7D%2Fapplications%2F%7Bid%7D%3APOST). ### Update Application by Key See API endpoint definition [POST /\{projectKey}/applications/key=\{key}](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Aendpoint%3A%2F%7BprojectKey%7D%2Fapplications%2Fkey%3D%7Bkey%7D%3APOST). ## Update actions The following update actions allow you to modify specific properties of an Application resource. Use them with the update endpoints as described above. #### Set Status See API type definition [SetApplicationStatusUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3ASetApplicationStatusUpdateAction). #### Set Name See API type definition [SetApplicationNameUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3ASetApplicationNameUpdateAction). #### Set Description See API type definition [SetDescriptionUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3ASetDescriptionUpdateAction). #### Set Application Logo See API type definition [SetApplicationLogoUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3ASetApplicationLogoUpdateAction). #### Set Countries See API type definition [SetCountriesUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3ASetCountriesUpdateAction). #### Add Country See API type definition [AddCountryUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3AAddCountryUpdateAction). #### Remove Country See API type definition [RemoveCountryUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3ARemoveCountryUpdateAction). #### Set Allowed Origins See API type definition [SetAllowedOriginsUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3ASetAllowedOriginsUpdateAction). #### Set Allow All Origins See API type definition [SetAllowAllOriginsUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3ASetAllowAllOriginsUpdateAction). #### Add Allowed Origin See API type definition [AddAllowedOriginUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3AAddAllowedOriginUpdateAction). #### Remove Allowed Origin See API type definition [RemoveAllowedOriginUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3ARemoveAllowedOriginUpdateAction). #### Set Payments Configuration See API type definition [SetPaymentsConfigurationUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3ASetPaymentsConfigurationUpdateAction). #### Set Payment Return URL See API type definition [SetPaymentReturnUrlUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3ASetPaymentReturnUrlUpdateAction). #### Set Active Payment Component Type See API type definition [SetActivePaymentComponentTypeUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3ASetActivePaymentComponentTypeUpdateAction). #### Set Discounts Configuration See API type definition [SetDiscountsConfigurationUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3ASetDiscountsConfigurationUpdateAction). #### Set Application Agreements See API type definition [SetApplicationAgreementsUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3ASetApplicationAgreementsUpdateAction). #### Add Application Agreement See API type definition [AddApplicationAgreementUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3AAddApplicationAgreementUpdateAction). #### Remove Application Agreement See API type definition [RemoveApplicationAgreementUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3ARemoveApplicationAgreementUpdateAction). #### Reorder Application Agreement See API type definition [ReorderApplicationAgreementUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3AReorderApplicationAgreementUpdateAction). #### Set Application Agreement Name See API type definition [SetApplicationAgreementNameUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3ASetApplicationAgreementNameUpdateAction). #### Set Application Agreement Type See API type definition [SetApplicationAgreementTypeUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3ASetApplicationAgreementTypeUpdateAction). #### Set Application Agreement Status See API type definition [SetApplicationAgreementStatusUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3ASetApplicationAgreementStatusUpdateAction). #### Set Application Agreement Text See API type definition [SetApplicationAgreementTextUpdateAction](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Atype%3ASetApplicationAgreementTextUpdateAction). ## Delete Application ### Delete Application by Key See API endpoint definition [DELETE /\{projectKey}/applications/key=\{key}](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Aendpoint%3A%2F%7BprojectKey%7D%2Fapplications%2Fkey%3D%7Bkey%7D%3ADELETE). ### Delete Application by ID See API endpoint definition [DELETE /\{projectKey}/applications/\{id}](https://docs.commercetools.com/checkout/applications-api.md?urn=ctp%3Acheckout%3Aendpoint%3A%2F%7BprojectKey%7D%2Fapplications%2F%7Bid%7D%3ADELETE). ## Allowed SortList When querying Applications, you can sort the results using the `sort` query parameter. The following fields are available for sorting: (a CSV formatted table follows. The first line are the column names.) Field,Description,Example `id`,Sort by Application ID,`id asc` `name`,Sort by Application name,`name desc` `mode`,Sort by Application mode (CompleteFlow, PaymentOnly),`mode asc` `status`,Sort by Application status (Active, Inactive),`status desc` `key`,Sort by Application key,`key asc` `createdAt`,Sort by creation timestamp,`createdAt desc` `lastModifiedAt`,Sort by the last modified timestamp,`lastModifiedAt asc` #### Sorting Examples Basic sorting: ``` GET /applications?sort=name asc GET /applications?sort=createdAt desc ``` Multiple sort criteria: ``` GET /applications?sort=status asc&sort=createdAt desc ``` Sorting with pagination: ``` GET /applications?sort=lastModifiedAt desc&limit=10&offset=0 ``` ## Related pages - [Section overview page](https://docs.commercetools.com/checkout.md) - [Next page: Payment Integrations](https://docs.commercetools.com/checkout/payment-integrations-api.md)