sdksio-postnl-ecommerce-apis-sdk
Version:
Collection of PostNL API's for ecommerce processes
36 lines (35 loc) • 2.04 kB
TypeScript
/**
* PostNL Ecommerce APIsLib
*
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
import { ApiResponse, RequestOptions } from '../core';
import { BarcodeResponse } from '../models/barcodeResponse';
import { Type1Enum } from '../models/type1Enum';
import { BaseController } from './baseController';
export declare class BarcodeController extends BaseController {
/**
* Request example:
* ```
* curl -X GET "https://api-sandbox.postnl.nl/shipment/v1_1/barcode?CustomerCode=DEVC&
* CustomerNumber=11223344&Type=3S&Serie=000000000-999999999&Range=NL" \
* -H "Accept: application/json" \
* -H "apikey: APIKEY-HERE"
* ```
*
*
* @param customerCode The customer code for which you want a barcode to be generated
* @param customerNumber The customer code for which you want a barcode to be generated
* @param type The barcode type that you want to be generated
* @param serie Barcode serie in the format '###000000-###000000', for example 100000-20000.
* The range must consist of a minimal difference of 100.000. It is allowed to add
* extra leading zeros at the beginning of the serie. See [Guidelines](https:
* //developer.postnl.nl/browse-apis/send-and-track/barcode-webservice/) for more
* information.
* @param range Only used for International Mail and Packet products (PEPS) shipments (with
* type LA, RI, UE). Identifying the issuing postal administration's country (NL
* in this case).
* @return Response from the API call
*/
generateAUniqueBarcode(customerCode: string, customerNumber: string, type: Type1Enum, serie?: string, range?: string, requestOptions?: RequestOptions): Promise<ApiResponse<BarcodeResponse>>;
}