Collection of commercetools API examples setup on top of Postman

Makefile 100.00%

audit-sdk postman-collection api-rest postman api

commercetools-postman-collection's Introduction

Composable Commerce Postman Collections

Postman provides a REST client that helps you executing API requests without any development effort. API requests can be organized into collections that you can import into Postman.

Theoretically, you can run the whole commerce journey from creating Customers and Products to creating Orders where these Customers purchase the Products.

Key benefits of using the Composable Commerce Postman Collections:

Works with minimum technical knowledge with no coding required
Can be used as soon as you have created a Project
The API endpoints can be explored to achieve a holistic view of how Composable Commerce and other services operate

This repository contains Postman Collections including requests and responses for most Composable Commerce endpoints. For each request, the smallest possible payload is given. Optional fields can be found in the related official documentation.

Additionally, the collections provide example requests and responses for specific tasks and more complex data models.

Disclaimer

This is not the official commercetools documentation. To learn more about Composable Commerce APIs and to find the complete and approved documentation, visit docs.commercetools.com.

Available Postman Collections

The following Postman Collections are available:

⚠️ Note:

Be aware that Postman automatically synchronizes environment variables (including your API Client credentials) to your workspace if logged in.

Use these collections only for development purposes and non-production projects.

Feel free to clone the collections and adjust them to your needs.

Getting started

For information on how to use the Composable Commerce Postman Collections and set up an environment, refer to Getting started.

commercetools-postman-collection's People

Contributors

Stargazers

Watchers

Forkers

robmoorman bezveza studentivan avalinx saurav-chakraborty-wawa grisiwt sschezar ijdoc bramkaashoek anusha5695 codacy20 muratcureklibatir andrianovsky jensvhal ovaisilyas dieguespedro chandan-khatri-by jakepeterson-commercetools tomasz-soltysik konradbm joelnguyenn1010 ajit1 travaux-de-bureau dasaep codewode xiaoyongxu lgelder ckodian-commercetools bogste ravibbg mismi deng8112 bhanualluril7 therealjawss patelnimesh iancalalang mij-th clayears ghoshsam karthikeyan-interatestudio munib atishroy munibhcl ayush-kumar-goel satyendrahcl apekshamadaan anamuduri sergioaduarte marcelxsander bartekdeity magnber joffyjv ashevchuk-rh rudgr childron zakhan-s shadrech go2redo marschmidt89 maxmudit navodya123 clouda-inc mamtamm mage2godev lealsergiobf pabloenriquez brianballard ericzhang-commercetools nitin-noodle bark-pkantheti elgharabawy yunushaik rg-ashokkumar pankajguru syndicate555 whimzylive vishnu-kp slahiri1 johnbenjaminmercado jjerin861 dmytrosmoltsvaltech1 jbvose svalapi autoglymmm nielshenriksen puneet-kundliya lagold27 adamlundberg icyparkinson joshibrs muhammad-jamil-1 vasanth-mahendran nilesh-gaikwad tamilheiro pramit-adhikari toddalker mantas-beniusis svennws panupongn jarandagarrido

commercetools-postman-collection's Issues

Postman collection (api) contains duplicate in URL : /products/{{ID}}/{{product-id}}

Doc : https://docs.commercetools.com/http-api-projects-products#update-product
Endpoint: /{projectKey}/products/{id}

Postman:
{{host}}/{{projectKey}}/products/{{ID}}/{{product-id}}

Flag BETA features in Postman

Is it feasible to designate features currently in Public Beta within Postman? This approach would enable developers to easily identify whether the features they intend to utilize are in the BETA phase.

Inconsistencies in collections for Project variable

Small inconsistencies that lead to the API request not automatically work after importing the collections into postman

API collection
https://github.com/commercetools/commercetools-postman-collection/blob/master/api/collection.json
The project key variable is {{project-key}}

Postman environment template collection
https://github.com/commercetools/commercetools-postman-collection/blob/master/api/template.json
There is no project key variable here.

Composable Commerce Merchant center Postman environment template (example values)
{ "id": "a02325d4-10f7-4e29-a942-ffe145dg2d60", "name": "hello-world-playground", "values": [ { "key": "host", "value": "https://api.australia-southeast1.gcp.commercetools.com", "enabled": true, "type": "text" }, { "key": "auth_url", "value": "https://auth.australia-southeast1.gcp.commercetools.com", "enabled": true, "type": "text" }, { "key": "projectKey", "value": "hello-world", "enabled": true, "type": "text" }, { "key": "client_id", "value": "5_j34MwUw3uSwoemfWCBeSWD", "enabled": true, "type": "text" }, { "key": "client_secret", "value": "8wxtSn6nGwCrjcB4GkIgMjHGCEpSU1ZP", "enabled": true, "type": "text" } ], "_postman_variable_scope": "environment", "_postman_exported_at": "2023-08-08T00:24:05.049Z", "_postman_exported_using": "Postman/6.0.10" }

The variable is projectKey and not project-key, leading to a miss match.

Misleading variable name in <get ByProjectKeyProductSelectionsByIDProducts>

In the new postman collection get query to fetch products that are assigned to a product selection contains wrong variable name.
Original:
{{host}}/{{project-key}}/product-selections/{{product-id}}/products

Correct version should be:
{{host}}/{{project-key}}/product-selections/{{product-selection-id}}/products

Authorization samples include a leading https://

A small issue with the authorization examples as they all lead with https://{{auth_url}}.....
The auth_url variable already contains a leading "https://" when downloaded from the Management Console / Developer / Create API client.

Users get the error :
"There was an error connecting to https://https://auth.sphere.io..."

Removing the https:// from the postman examples avoids this error.

Remove legacy hostnames

Description

To improve the developer experience and easen our support and training burden all existing references to *.sphere.io and .commercetools.co host names should be removed in favor of not defaulting to a specific region (a common complaint of US and AWS customers is that EU is defaulted everywhere) or, if needed for backwards compatibility, be replaced with the new *.europe-west1.gcp.commercetools.com notation.

Expected Behavior

full text search over the repository for ".sphere.io" and ".commercetools.co" should yield zero results

Context

https://docs.commercetools.com/release-notes#releases-2020-02-03-aws-and-new-hostnames

Auto-encode query parameters

When using the postmen collection, one of the biggest hurdles is that each Query Parameter has to be encoded manually. Now if you only occasionally using the collection it may not seem like a big deal, but having to constantly right click then encode the values can be quite tiresom.

If the collection would contain the bellow snippet, then this encoding would:

happen automagically
can be turned off, if desired.

And it can be defined on the Project folder, and inherently every request could leverage it.

if (pm.globals.get("PM_DISABLE_AUTO_ENCODE")!=="true") {   
    pm.request.url.query.each((param) => {
        param.value = encodeURIComponent(param.value);
    });
}

Misleading variable name in <get ByProjectKeyProductSelectionsKeyByKeyProducts>

Correct version should be:
{{host}}/{{project-key}}/product-selections/key={{product-selection-key}}/products

Also shouldn't the name be get ByProjectKeyProductSelectionsByKeyProducts?

Broken links

Collection and template links are broken in all 3 docs (api, import and ml):
Import the collection.json and template.json in your postman application

commercetools / commercetools-postman-collection Goto Github PK