Backbone - fulfillment API TS Client

Introduction

The fulfillment API TS Client enables you to work with the fulfillment API.

Prerequisites

• npm

Installation

You can use npm to install the package.

npm install @datenkraft/bb-fulfillment-api-ts-client

Using the package

The package can be used to communicate with the fulfillment API. The Client includes functionalities for every endpoint defined in the openapi.json. The Client is auto-generated with OpenAPITools using an openapi.json file.

Initializing the Client and calling an Endpoint

import { ConfigOptions } from '@datenkraft/bb-base-api-ts-client';
import { FulfillmentApiClient } from '@datenkraft/bb-fulfillment-api-ts-client';
import { ShopApi } from '@datenkraft/bb-fulfillment-api-ts-client/Generated';

const configOptions: ConfigOptions = {
  clientId: 'clientId',
  clientSecret: 'clientSecret',
  oAuthTokenHost: 'oAuthTokenHost',
  tokenTradeInPath: 'tokenTradeInPath',
  externalIdToken: 'externalIdToken',
  useExternalIdToken: true,
};

FulfillmentApiClient.getApiConfig(configOptions).then((config) => {
  const XxxApi = new XxxApi(config);
  XxxApi.getXxxCollection().then((data) => {});
});

License

This repository is available under the MIT license.