@tradecafe/package-tracking-sdk

Packge Tracking SDK

This contains the SDK to be used against the Template Service.

Installation

npm install @tradecafe/package-tracking-sdk --save

Usage

Initializing client

const sdk = require('@tradecafe/package-tracking-sdk');

let client = sdk({
	baseURL: 'http://service.base.url/'
});

Executing calls

client.create({
    carrier: 'fedex',
    code: {
        trackingNumber: '1234'
    },
    deal_id: 'deal-id',
    tags: ['tag4', 'tag5']
}, function(err, result) {
    if(err) {
        done(err);
    } else {
        done();
    }
});

API

create

Creates the specified package and returns it's id and the resulting object

let item = {
  account: 'account-id',
  carrier: 'fedex',
  code: {
      trackingNumber: '1234'
  },
  deal_id: 'deal-id',
  tags: ['tag4', 'tag5']
};
client.create(item, (err, package_id, object) => {
	
});

Delete

Deletes a single specified package

client.del(account, id, (err) => {
	
});

Get

Retrieves a single package

client.get(account, id, (err, object) => {
	
});

List

Retrieves a list of packages that belong to your account. Optionally you can provide a deal_id which will be applied as a filter.

client.search({account: 'account-id', deal_id: 'deal-id'}, (err, object) => {
	
});

Track

Modifies the track parameter of the object

track is a boolean

client.track(account, id, track, (err, object) => {
	
}, party);

Further development

If you are going to develop this further, please assure proper test coverage.

Tests can currently run using npm test or mocha application home.