Skip to content

BulkApi.md

Latest commit

 

History

History
184 lines (126 loc) · 4.96 KB

BulkApi.md

File metadata and controls

184 lines (126 loc) · 4.96 KB

SwappyRestApi.BulkApi

All URIs are relative to https://api.swappy.com/

Method HTTP request Description
createBulkJob POST /v1/bulkjobs
getBulkJob GET /v1/bulkjobs/{id}
getBulkJobResult GET /v1/bulkjobs/{id}/results

createBulkJob

BulkJob createBulkJob(body, opts)

Start a bulk product job

Example

var SwappyRestApi = require('swappy_rest_api');
var defaultClient = SwappyRestApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth
var oauth = defaultClient.authentications['oauth'];
oauth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SwappyRestApi.BulkApi();

var body = [new SwappyRestApi.Product()]; // [Product] | Product list to be uploaded

var opts = { 
  'language': "language_example" // String | Language for the response
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createBulkJob(body, opts, callback);

Parameters

Name Type Description Notes
body [Product] Product list to be uploaded
language String Language for the response [optional]

Return type

BulkJob

Authorization

oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getBulkJob

BulkJob getBulkJob(id, opts)

Get infos about a job

Example

var SwappyRestApi = require('swappy_rest_api');
var defaultClient = SwappyRestApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth
var oauth = defaultClient.authentications['oauth'];
oauth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SwappyRestApi.BulkApi();

var id = 56; // Integer | Product ID

var opts = { 
  'ifNoneMatch': "ifNoneMatch_example", // String | Etag, will return `304 Not Modified` if content hasn't changed
  'ifModifiedSince': new Date("2013-10-20T19:20:30+01:00"), // Date | Will return `304 Not Modified` if content hasn't changed
  'language': "language_example" // String | Language for the response
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getBulkJob(id, opts, callback);

Parameters

Name Type Description Notes
id Integer Product ID
ifNoneMatch String Etag, will return `304 Not Modified` if content hasn't changed [optional]
ifModifiedSince Date Will return `304 Not Modified` if content hasn't changed [optional]
language String Language for the response [optional]

Return type

BulkJob

Authorization

oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getBulkJobResult

[BulkJobResult] getBulkJobResult(id, opts)

Get results for a job

Example

var SwappyRestApi = require('swappy_rest_api');
var defaultClient = SwappyRestApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth
var oauth = defaultClient.authentications['oauth'];
oauth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new SwappyRestApi.BulkApi();

var id = 56; // Integer | Product ID

var opts = { 
  'ifNoneMatch': "ifNoneMatch_example", // String | Etag, will return `304 Not Modified` if content hasn't changed
  'ifModifiedSince': new Date("2013-10-20T19:20:30+01:00"), // Date | Will return `304 Not Modified` if content hasn't changed
  'language': "language_example" // String | Language for the response
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getBulkJobResult(id, opts, callback);

Parameters

Name Type Description Notes
id Integer Product ID
ifNoneMatch String Etag, will return `304 Not Modified` if content hasn't changed [optional]
ifModifiedSince Date Will return `304 Not Modified` if content hasn't changed [optional]
language String Language for the response [optional]

Return type

[BulkJobResult]

Authorization

oauth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json