Node.js

Shopware 6 - Find Product by Name

See more Shopware 6 Examples

Find a product with a given name and get the id. Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var http = new chilkat.Http();

    // Sends the following POST to find the product named "Test123"

    // POST /api/v3/search/product
    // {
    //     "filter": [
    //         { "type": "equals", "field": "name", "value": "Test123" }
    //     ],
    //     "includes": {
    //         "product": ["id", "name"]
    //     }
    // }

    // Create the above JSON.
    // Use this online tool to generate code from sample JSON:
    // Generate Code to Create JSON

    var json = new chilkat.JsonObject();
    json.UpdateString("filter[0].type","equals");
    json.UpdateString("filter[0].field","name");
    json.UpdateString("filter[0].value","Test123");
    json.UpdateString("includes.product[0]","id");
    json.UpdateString("includes.product[1]","name");
    // 

    // Load the access token previously obtained in Shopware 6 OAuth2 Client Credentials
    var jsonToken = new chilkat.JsonObject();
    jsonToken.LoadFile("qa_data/tokens/shopware6.json");

    // This causes the "Authorization: Bearer <access_token>" header to be added.
    http.AuthToken = jsonToken.StringOf("access_token");

    // Note: If you get a 401 response status code, then fetch a new access token and retry.
    var resp = new chilkat.HttpResponse();
    success = http.HttpJson("POST","https://my-shopware-6-shop.de/api/v3/search/product",json,"application/json",resp);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

    var sbResponseBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbResponseBody);
    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    // If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
    var respStatusCode = resp.StatusCode;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(resp.Header);
        console.log("Failed.");
        return;
    }

    // The response looks like this:
    // Use the following online tool to generate parsing code from sample JSON:
    // Generate Parsing Code from JSON

    // {
    //   "data": [
    //     {
    //       "id": "d195dabb53cf46d096bd9a8726d82558",
    //       "type": "product",
    //       "attributes": {
    //         "name": "Test123",
    //         "apiAlias": null
    //       },
    //       "links": {
    //         "self": "https:\/\/***.de\/api\/v3\/product\/d195dabb53cf46d096bd9a8726d82558"
    //       },
    //       "relationships": [
    //       ],
    //       "meta": null
    //     }
    //   ],
    //   "included": [
    //   ],
    //   "links": {
    //     "self": "https:\/\/***.de\/api\/v3\/search\/product"
    //   },
    //   "meta": {
    //     "totalCountMode": 0,
    //     "total": 1
    //   },
    //   "aggregations": [
    //   ]
    // }

    var numSearchResults = jResp.SizeOfArray("data");
    if (numSearchResults !== 1) {
        console.log("numSearchResults = " + numSearchResults);
        console.log("Did not find the product, or unexpectedly found more than one with the same name.");
        return;
    }

    var productId = jResp.StringOf("data[0].id");

    console.log("Product ID = " + productId);

}

chilkatExample();