TradeGecko NodeJS API Connector

A NodeJS connector for simplifying interactions with the TradeGecko API.

Usage

You will need an api token to instantiate the connector.

const TradeGecko  = require('@apigrate/tradegecko');
let tg = new TradeGecko({
  apiToken: 'your API token from secure storage'
});

List Objects

Use the get method to list objects. Sideloading is supported. When nothing is found that matches the search criteria, the method returns an empty array response (see example below).

Example request:

let result = await tg.get('/products', {ids:"31438119,31479255", include: 'variants'});

Example response (fields omitted):

{
  "variants": [ //sideloading supported
    {
      "id": 59476653,
      //...additional fields
    },
    {
      "id": 59354382,
      //...additional fields
    }
  ],
  "products": [
    {
      "id": 31479255,
      //...additional fields
      "variant_ids": [
        59476653
      ]
    },
    {
      "id": 31538119,
      //...additional fields
      "variant_ids": [
        59354382
      ]
    }
  ]
}

Example empty response:

{
  "products": []
}

Get Objects By ID

Use the get method to get a single object by id. Sideloading is supported. When an object is not found, this method returns null.

Example request:

let result = await tg.get('/products/31479255', {include: 'variants'});

Example response (fields omitted):

{
  "variants": [ //sideloading supported
    {
      "id": 59476653,
      //...additional fields
    }
  ],
  "product": { //<-- IMPORTANT! note singular "product", NOT "products"
    "id": 31479255,
    //...additional fields
    "variant_ids": [
      59476653
    ]
  }
}

Create an Object

Use the post method to create an object.

let payload = {product:{
  name: "Test Product",
  description: "This is a test product. Please do not use it.",
  tags: "Test",
}};
let result = await tg.post('/products', payload);
console.log(`After create:\n${JSON.stringify(result, null, 2)}`);

Update an Object

Use the put method to update an object. You should append the entity id to the endpoint base url.

//Update the product (note: nothing is returned on HTTP-204)
payload.product.description = "Just updated the description. Please do not use this product, though.";
await tg.put(`/products/${payload.product.id}`, payload);

Delete an Object

Use the delete method to delete an object. You should append the entity id to the endpoint base url.

//Delete the product (nothing is returned on HTTP-204)
await tg.delete('/products/33427131');

Rate Limiting and Request IDs

The connector captures rate limits internally from the last request. It does not implement any specific rate-limiting logic-this is left as a choice for developer to implement.

Get the rate limit information from the last request:

console.log(
`
Last Request ID: ${tg.request_id}
Rate Limit: ${tg.rate_limit}
Rate Limit Remaining: ${tg.rate_limit_remaining}
Rate Limit Resets: ${moment.unix(tg.rate_limit_reset).format("M/D/YYYY HH:mm:ssZ")}
`);
// note, use of moment is not a bundled dependency

Debug Available

You can enable debugging (courtesy of the debug module):

process.env.DEBUG = 'gr8:tradegecko';

Debugging information includes the raw response data.

Full API Example

const TradeGecko  = require('@apigrate/tradegecko');

let tg = new TradeGecko( { apiToken: process.env.TRADEGECKO_API_TOKEN } );

(async function(){
  let result = null;
  try{

    //Query a product (shows how to sideload variants as well)
    result = await tg.get('/products', {page: 1, limit: 5, status: "active", include: "variants"});

    //Query a product by specific ids
    result = await tg.get('/products', {ids:"33229976,33230500"});

    //Get a single product (note, the "product" (not "products") property in the response)
    result = await tg.get('/products/33229976');


    //Create a product
    let payload = {product:{
      name: "Test Product",
      description: "This is a test product. Please do not use it.",
      tags: "Test",
    }};
    result = await tg.post('/products', payload);
    console.log(`After create:\n${JSON.stringify(result, null, 2)}`);

    //Update the product (nothing is returned on HTTP-204)
    payload.product.description = "Just updated the description. Please do not use this product, though.";
    await tg.put(`/products/${payload.product.id}`, payload);

    //Delete the product (nothing is returned on HTTP-204)
    await tg.delete('/products/33427131');

    console.log(`${JSON.stringify(result, null, 2)}`);

    console.log(`Last Request ID: ${tg.request_id}\nRate Limit: ${tg.rate_limit}\nRate Limit Remaining: ${tg.rate_limit_remaining}\nRate Limit Resets: ${moment.unix(tg.rate_limit_reset).format("M/D/YYYY HH:mm:ssZ")}`);

  }catch(ex){
    console.error(ex);
  }

})()

This connector brought to you by...

Apigrate develops applications that make businesses of all sizes more efficient.