shipstation-client

/** * ShipStation API v2 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 2.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { type RequestArgs, BaseAPI } from '../base'; import type { CreateLabelFromRateRequestBody } from '../models'; import type { CreateLabelFromRateResponseBody } from '../models'; import type { CreateLabelFromShipmentRequestBody } from '../models'; import type { CreateLabelFromShipmentResponseBody } from '../models'; import type { CreateLabelRequestBody } from '../models'; import type { CreateLabelResponseBody } from '../models'; import type { CreateReturnLabelRequestBody } from '../models'; import type { CreateReturnLabelResponseBody } from '../models'; import type { GetLabelByIdResponseBody } from '../models'; import type { GetTrackingLogFromLabelResponseBody } from '../models'; import type { LabelDownloadType } from '../models'; import type { LabelStatus } from '../models'; import type { ListLabelsResponseBody } from '../models'; import type { SortDir } from '../models'; import type { VoidLabelResponseBody } from '../models'; /** * LabelsApi - axios parameter creator * @export */ export declare const LabelsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Purchase and print a label for shipment. * @summary Purchase label * @param {CreateLabelRequestBody} createLabelRequestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLabel: (createLabelRequestBody: CreateLabelRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * When retrieving rates for shipments using the `/rates` endpoint, the returned information contains a `rate_id` property that can be used to generate a label without having to refill in the shipment information repeatedly. * @summary Purchase label with rate id * @param {string} rateId Rate ID * @param {CreateLabelFromRateRequestBody} createLabelFromRateRequestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLabelFromRate: (rateId: string, createLabelFromRateRequestBody: CreateLabelFromRateRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Purchase a label using a shipment ID that has already been created with the desired address and package info. * @summary Purchase label with shipment id * @param {string} shipmentId Shipment ID * @param {CreateLabelFromShipmentRequestBody} createLabelFromShipmentRequestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLabelFromShipment: (shipmentId: string, createLabelFromShipmentRequestBody: CreateLabelFromShipmentRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Create a return label for a previously created outbound label. The return label will automatically swap the ship to and ship from addresses from the original label. * @summary Create a return label * @param {string} labelId Label ID * @param {CreateReturnLabelRequestBody} createReturnLabelRequestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ createReturnLabel: (labelId: string, createReturnLabelRequestBody: CreateReturnLabelRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Retrieve a specific label by its label id. * @summary Get label by id * @param {string} labelId Label ID * @param {LabelDownloadType} [labelDownloadType] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLabelById: (labelId: string, labelDownloadType?: LabelDownloadType, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Retrieve the label\'s tracking details. * @summary Get label tracking information * @param {string} labelId Label ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTrackingLogFromLabel: (labelId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * This method returns a list of labels that you\'ve created. You can optionally filter the results as well as control their sort order and the number of results returned at a time. By default all labels are returned 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. For example, if you only want your UPS labels for your east coast warehouse you could query by both `warehouse_id` and `carrier_id`. * @summary List labels * @param {LabelStatus} [labelStatus] Only return labels that are currently in the specified status. * @param {string} [serviceCode] Only return labels for a specific carrier service. * @param {string} [carrierId] Carrier ID * @param {string} [trackingNumber] The tracking number associated with a shipment * @param {string} [batchId] Batch ID * @param {string} [rateId] Rate ID * @param {string} [shipmentId] Shipment ID * @param {string} [warehouseId] Warehouse ID * @param {string} [createdAtStart] Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) * @param {string} [createdAtEnd] Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time) * @param {number} [page] Return a specific page of results. Defaults to the first page. If set to a number that\'s greater than the number of pages of results, an empty page is returned. * @param {number} [pageSize] The number of results to return per response. * @param {SortDir} [sortDir] Controls the sort order of the query. * @param {ListLabelsSortByEnum} [sortBy] Controls which field the query is sorted by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listLabels: (labelStatus?: LabelStatus, serviceCode?: string, carrierId?: string, trackingNumber?: string, batchId?: string, rateId?: string, shipmentId?: string, warehouseId?: string, createdAtStart?: string, createdAtEnd?: string, page?: number, pageSize?: number, sortDir?: SortDir, sortBy?: ListLabelsSortByEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * Void a specific label using its label id. For labels that are paid for at time of label creation, this will also request a refund from the carrier. * @summary Void a label by id * @param {string} labelId Label ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ voidLabel: (labelId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; }; /** * LabelsApi - functional programming interface * @export */ export declare const LabelsApiFp: (configuration?: Configuration) => { /** * Purchase and print a label for shipment. * @summary Purchase label * @param {CreateLabelRequestBody} createLabelRequestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLabel(createLabelRequestBody: CreateLabelRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLabelResponseBody>>; /** * When retrieving rates for shipments using the `/rates` endpoint, the returned information contains a `rate_id` property that can be used to generate a label without having to refill in the shipment information repeatedly. * @summary Purchase label with rate id * @param {string} rateId Rate ID * @param {CreateLabelFromRateRequestBody} createLabelFromRateRequestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLabelFromRate(rateId: string, createLabelFromRateRequestBody: CreateLabelFromRateRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLabelFromRateResponseBody>>; /** * Purchase a label using a shipment ID that has already been created with the desired address and package info. * @summary Purchase label with shipment id * @param {string} shipmentId Shipment ID * @param {CreateLabelFromShipmentRequestBody} createLabelFromShipmentRequestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLabelFromShipment(shipmentId: string, createLabelFromShipmentRequestBody: CreateLabelFromShipmentRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLabelFromShipmentResponseBody>>; /** * Create a return label for a previously created outbound label. The return label will automatically swap the ship to and ship from addresses from the original label. * @summary Create a return label * @param {string} labelId Label ID * @param {CreateReturnLabelRequestBody} createReturnLabelRequestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ createReturnLabel(labelId: string, createReturnLabelRequestBody: CreateReturnLabelRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateReturnLabelResponseBody>>; /** * Retrieve a specific label by its label id. * @summary Get label by id * @param {string} labelId Label ID * @param {LabelDownloadType} [labelDownloadType] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLabelById(labelId: string, labelDownloadType?: LabelDownloadType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLabelByIdResponseBody>>; /** * Retrieve the label\'s tracking details. * @summary Get label tracking information * @param {string} labelId Label ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTrackingLogFromLabel(labelId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrackingLogFromLabelResponseBody>>; /** * This method returns a list of labels that you\'ve created. You can optionally filter the results as well as control their sort order and the number of results returned at a time. By default all labels are returned 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. For example, if you only want your UPS labels for your east coast warehouse you could query by both `warehouse_id` and `carrier_id`. * @summary List labels * @param {LabelStatus} [labelStatus] Only return labels that are currently in the specified status. * @param {string} [serviceCode] Only return labels for a specific carrier service. * @param {string} [carrierId] Carrier ID * @param {string} [trackingNumber] The tracking number associated with a shipment * @param {string} [batchId] Batch ID * @param {string} [rateId] Rate ID * @param {string} [shipmentId] Shipment ID * @param {string} [warehouseId] Warehouse ID * @param {string} [createdAtStart] Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) * @param {string} [createdAtEnd] Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time) * @param {number} [page] Return a specific page of results. Defaults to the first page. If set to a number that\'s greater than the number of pages of results, an empty page is returned. * @param {number} [pageSize] The number of results to return per response. * @param {SortDir} [sortDir] Controls the sort order of the query. * @param {ListLabelsSortByEnum} [sortBy] Controls which field the query is sorted by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listLabels(labelStatus?: LabelStatus, serviceCode?: string, carrierId?: string, trackingNumber?: string, batchId?: string, rateId?: string, shipmentId?: string, warehouseId?: string, createdAtStart?: string, createdAtEnd?: string, page?: number, pageSize?: number, sortDir?: SortDir, sortBy?: ListLabelsSortByEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListLabelsResponseBody>>; /** * Void a specific label using its label id. For labels that are paid for at time of label creation, this will also request a refund from the carrier. * @summary Void a label by id * @param {string} labelId Label ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ voidLabel(labelId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VoidLabelResponseBody>>; }; /** * LabelsApi - factory interface * @export */ export declare const LabelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Purchase and print a label for shipment. * @summary Purchase label * @param {CreateLabelRequestBody} createLabelRequestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLabel(createLabelRequestBody: CreateLabelRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<CreateLabelResponseBody>; /** * When retrieving rates for shipments using the `/rates` endpoint, the returned information contains a `rate_id` property that can be used to generate a label without having to refill in the shipment information repeatedly. * @summary Purchase label with rate id * @param {string} rateId Rate ID * @param {CreateLabelFromRateRequestBody} createLabelFromRateRequestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLabelFromRate(rateId: string, createLabelFromRateRequestBody: CreateLabelFromRateRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<CreateLabelFromRateResponseBody>; /** * Purchase a label using a shipment ID that has already been created with the desired address and package info. * @summary Purchase label with shipment id * @param {string} shipmentId Shipment ID * @param {CreateLabelFromShipmentRequestBody} createLabelFromShipmentRequestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLabelFromShipment(shipmentId: string, createLabelFromShipmentRequestBody: CreateLabelFromShipmentRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<CreateLabelFromShipmentResponseBody>; /** * Create a return label for a previously created outbound label. The return label will automatically swap the ship to and ship from addresses from the original label. * @summary Create a return label * @param {string} labelId Label ID * @param {CreateReturnLabelRequestBody} createReturnLabelRequestBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ createReturnLabel(labelId: string, createReturnLabelRequestBody: CreateReturnLabelRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<CreateReturnLabelResponseBody>; /** * Retrieve a specific label by its label id. * @summary Get label by id * @param {string} labelId Label ID * @param {LabelDownloadType} [labelDownloadType] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLabelById(labelId: string, labelDownloadType?: LabelDownloadType, options?: RawAxiosRequestConfig): AxiosPromise<GetLabelByIdResponseBody>; /** * Retrieve the label\'s tracking details. * @summary Get label tracking information * @param {string} labelId Label ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTrackingLogFromLabel(labelId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetTrackingLogFromLabelResponseBody>; /** * This method returns a list of labels that you\'ve created. You can optionally filter the results as well as control their sort order and the number of results returned at a time. By default all labels are returned 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. For example, if you only want your UPS labels for your east coast warehouse you could query by both `warehouse_id` and `carrier_id`. * @summary List labels * @param {LabelStatus} [labelStatus] Only return labels that are currently in the specified status. * @param {string} [serviceCode] Only return labels for a specific carrier service. * @param {string} [carrierId] Carrier ID * @param {string} [trackingNumber] The tracking number associated with a shipment * @param {string} [batchId] Batch ID * @param {string} [rateId] Rate ID * @param {string} [shipmentId] Shipment ID * @param {string} [warehouseId] Warehouse ID * @param {string} [createdAtStart] Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) * @param {string} [createdAtEnd] Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time) * @param {number} [page] Return a specific page of results. Defaults to the first page. If set to a number that\'s greater than the number of pages of results, an empty page is returned. * @param {number} [pageSize] The number of results to return per response. * @param {SortDir} [sortDir] Controls the sort order of the query. * @param {ListLabelsSortByEnum} [sortBy] Controls which field the query is sorted by. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listLabels(labelStatus?: LabelStatus, serviceCode?: string, carrierId?: string, trackingNumber?: string, batchId?: string, rateId?: string, shipmentId?: string, warehouseId?: string, createdAtStart?: string, createdAtEnd?: string, page?: number, pageSize?: number, sortDir?: SortDir, sortBy?: ListLabelsSortByEnum, options?: RawAxiosRequestConfig): AxiosPromise<ListLabelsResponseBody>; /** * Void a specific label using its label id. For labels that are paid for at time of label creation, this will also request a refund from the carrier. * @summary Void a label by id * @param {string} labelId Label ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ voidLabel(labelId: string, options?: RawAxiosRequestConfig): AxiosPromise<VoidLabelResponseBody>; }; /** * LabelsApi - object-oriented interface * @export * @class LabelsApi * @extends {BaseAPI} */ export declare class LabelsApi extends BaseAPI { /** * Purchase and print a label for shipment. * @summary Purchase label * @param {CreateLabelRequestBody} createLabelRequestBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LabelsApi */ createLabel(createLabelRequestBody: CreateLabelRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").Label, any>>; /** * When retrieving rates for shipments using the `/rates` endpoint, the returned information contains a `rate_id` property that can be used to generate a label without having to refill in the shipment information repeatedly. * @summary Purchase label with rate id * @param {string} rateId Rate ID * @param {CreateLabelFromRateRequestBody} createLabelFromRateRequestBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LabelsApi */ createLabelFromRate(rateId: string, createLabelFromRateRequestBody: CreateLabelFromRateRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").Label, any>>; /** * Purchase a label using a shipment ID that has already been created with the desired address and package info. * @summary Purchase label with shipment id * @param {string} shipmentId Shipment ID * @param {CreateLabelFromShipmentRequestBody} createLabelFromShipmentRequestBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LabelsApi */ createLabelFromShipment(shipmentId: string, createLabelFromShipmentRequestBody: CreateLabelFromShipmentRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").Label, any>>; /** * Create a return label for a previously created outbound label. The return label will automatically swap the ship to and ship from addresses from the original label. * @summary Create a return label * @param {string} labelId Label ID * @param {CreateReturnLabelRequestBody} createReturnLabelRequestBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LabelsApi */ createReturnLabel(labelId: string, createReturnLabelRequestBody: CreateReturnLabelRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").Label, any>>; /** * Retrieve a specific label by its label id. * @summary Get label by id * @param {string} labelId Label ID * @param {LabelDownloadType} [labelDownloadType] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LabelsApi */ getLabelById(labelId: string, labelDownloadType?: LabelDownloadType, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").Label, any>>; /** * Retrieve the label\'s tracking details. * @summary Get label tracking information * @param {string} labelId Label ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LabelsApi */ getTrackingLogFromLabel(labelId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").TrackingInformation, any>>; /** * This method returns a list of labels that you\'ve created. You can optionally filter the results as well as control their sort order and the number of results returned at a time. By default all labels are returned 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. For example, if you only want your UPS labels for your east coast warehouse you could query by both `warehouse_id` and `carrier_id`. * @summary List labels * @param {LabelStatus} [labelStatus] Only return labels that are currently in the specified status. * @param {string} [serviceCode] Only return labels for a specific carrier service. * @param {string} [carrierId] Carrier ID * @param {string} [trackingNumber] The tracking number associated with a shipment * @param {string} [batchId] Batch ID * @param {string} [rateId] Rate ID * @param {string} [shipmentId] Shipment ID * @param {string} [warehouseId] Warehouse ID * @param {string} [createdAtStart] Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) * @param {string} [createdAtEnd] Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time) * @param {number} [page] Return a specific page of results. Defaults to the first page. If set to a number that\'s greater than the number of pages of results, an empty page is returned. * @param {number} [pageSize] The number of results to return per response. * @param {SortDir} [sortDir] Controls the sort order of the query. * @param {ListLabelsSortByEnum} [sortBy] Controls which field the query is sorted by. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LabelsApi */ listLabels(labelStatus?: LabelStatus, serviceCode?: string, carrierId?: string, trackingNumber?: string, batchId?: string, rateId?: string, shipmentId?: string, warehouseId?: string, createdAtStart?: string, createdAtEnd?: string, page?: number, pageSize?: number, sortDir?: SortDir, sortBy?: ListLabelsSortByEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").PagedListResponseBody, any>>; /** * Void a specific label using its label id. For labels that are paid for at time of label creation, this will also request a refund from the carrier. * @summary Void a label by id * @param {string} labelId Label ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LabelsApi */ voidLabel(labelId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VoidLabelResponseBody, any>>; } /** * @export */ export declare const ListLabelsSortByEnum: { readonly ModifiedAt: "modified_at"; readonly CreatedAt: "created_at"; }; export type ListLabelsSortByEnum = typeof ListLabelsSortByEnum[keyof typeof ListLabelsSortByEnum];