@returnlogic/trade-gecko-api v1.0.4

TradeGecko API Node.js

Installation:

$ npm install --save @returnlogic/trade-gecko-api

// Using Yarn

$ yarn add @returnlogic/trade-gecko-api

API

Constructor Function That Takes an AccessToken Argument

TradeGecko(accessToken)

Creates a new TradeGecko Instance

Arguments

• accessToken - Required - A unique key used to make request to the TradeGecko API.

Resources

Resources are accessed through a TradeGecko instance

const tradeGecko = require('trade-gecko-api-client')({
    accessToken
});

All tradeGecko resource methods return a promise

tradeGecko.address.list().then(result => {

}).catch(err => {

});

Resource Names and Methods

• address
  • create([bodyParams])
  • retrieve(address_code)
  • list([queryParams])
  • update(address_code [, bodyParams])
  • remove(address_code)
• company
  • create([bodyParams])
  • retrieve(company_code)
  • update(company_code [, bodyParams])
  • remove(company_code)
• currency
  • create([bodyParams])
  • retrieve(currency_code)
  • list([queryParams])
  • update(currency_code [, bodyParams])
  • remove(currency_code)
• fulfillmentReturn
  • create([bodyParams])
  • retrieve(fulfillment_return_code)
  • list([queryParams])
  • update(fulfillment_return_code [, bodyParams])
  • remove(fulfillment_return_code)
• invoice
  • create([bodyParams])
  • retrieve(invoice_code)
  • list([queryParams])
  • update(invoice_code [, bodyParams])
  • remove(invoice_code)
• order
  • create([bodyParams])
  • retrieve(order_code)
  • list([queryParams])
  • update(order_code [, bodyParams])
  • remove(order_code)
  • actions(id, action)
• orderLineItem
  • create([bodyParams])
  • retrieve(order_line_item_code)
  • list([queryParams])
  • update(order_line_item_code [, bodyParams])
  • remove(order_line_item_code)
• product
  • create([bodyParams])
  • retrieve(product_code)
  • list([queryParams])
  • update(product_code [, bodyParams])
  • remove(product_code)
• purchaseOrder
  • create([bodyParams])
  • retrieve(purchase_order_code)
  • list([queryParams])
  • update(purchase_order_code [, bodyParams])
  • remove(purchase_order_code)
  • actions(id, action)
• stockAdjustmentLineItem
  • create([bodyParams])
  • retrieve(stock_adjustment_line_item_code)
  • list([queryParams])
  • remove(stock_adjustment_line_item_code)
• stockLevel
  • list([queryParams])
  • retrieve(stock_level)
• taxType
  • create([bodyParams])
  • retrieve(tax_type_code)
  • list([queryParams])
  • update(tax_type_code [, bodyParams])
  • remove(tax_type_code)
• user
  • create([bodyParams])
  • retrieve(user_code)
  • list([queryParams])
  • update(user_code [, bodyParams])
  • remove(user_code)
  • current()
• variant
  • create([bodyParams])
  • retrieve(variant_code)
  • list([queryParams])
  • update(variant_code [, bodyParams])
  • remove(variant_code)