@sp-api-sdk/external-fulfillment-shipments-api-2024-09-11 1.1.0

package/dist/es/api-model/models/tax-registration-info.js

@@ -0,0 +1,17 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The Selling Partner API for Amazon External Fulfillment Shipments Processing
+ * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export const TaxRegistrationInfoTypeEnum = {
+    Vat: 'VAT',
+    Gst: 'GST'
+};

package/dist/es/api-model/models/tax.js

@@ -0,0 +1,24 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The Selling Partner API for Amazon External Fulfillment Shipments Processing
+ * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export const TaxTypeEnum = {
+    Vat: 'VAT',
+    Cst: 'CST',
+    Igst: 'IGST',
+    Sgst: 'SGST',
+    Cgst: 'CGST',
+    Utgst: 'UTGST',
+    Cess: 'CESS',
+    Other: 'OTHER',
+    Total: 'TOTAL'
+};

package/dist/es/api-model/models/time-window.js

@@ -0,0 +1,17 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The Selling Partner API for Amazon External Fulfillment Shipments Processing
+ * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export const TimeWindowHandoverMethodEnum = {
+    Pickup: 'PICKUP',
+    Dropoff: 'DROPOFF'
+};

package/dist/es/api-model/models/weight.js

@@ -0,0 +1,17 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The Selling Partner API for Amazon External Fulfillment Shipments Processing
+ * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export const WeightWeightUnitEnum = {
+    G: 'G',
+    Kg: 'KG'
+};

package/dist/es/client.js

@@ -0,0 +1,9 @@
+import { createAxiosInstance } from '@sp-api-sdk/common';
+import { Configuration, ExternalFulfillmentShipmentsApi } from './api-model';
+export const clientRateLimits = [];
+export class ExternalFulfillmentShipmentsApiClient extends ExternalFulfillmentShipmentsApi {
+    constructor(configuration) {
+        const { axios, endpoint } = createAxiosInstance(configuration, clientRateLimits);
+        super(new Configuration(), endpoint, axios);
+    }
+}

package/dist/es/index.js

@@ -0,0 +1,3 @@
+export * from './client';
+export * from './api-model/api';
+export * from './api-model/models';

package/dist/types/api-model/api/external-fulfillment-shipments-api.d.ts

@@ -0,0 +1,556 @@
+/**
+ * The Selling Partner API for Amazon External Fulfillment Shipments Processing
+ * You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon\'s external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.
+ *
+ * The version of the OpenAPI document: 2024-09-11
+ * Contact: marketplaceapitest@amazon.com
+ *
+ * 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 globalAxios from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { InvoiceResponse } from '../models';
+import type { Package } from '../models';
+import type { PackageDeliveryStatus } from '../models';
+import type { Packages } from '../models';
+import type { ShipLabelsInput } from '../models';
+import type { ShipLabelsResponse } from '../models';
+import type { Shipment } from '../models';
+import type { ShipmentAcknowledgementRequest } from '../models';
+import type { ShipmentsResponse } from '../models';
+import type { ShippingOptionsResponse } from '../models';
+/**
+ * ExternalFulfillmentShipmentsApi - axios parameter creator
+ */
+export declare const ExternalFulfillmentShipmentsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Provide details about the packages in the specified shipment.
+     * @param {string} shipmentId The ID of the shipment.
+     * @param {Packages} body A list of packages in the shipment.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPackages: (shipmentId: string, body: Packages, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get invoices for the shipment you specify.
+     * @param {string} shipmentId The ID of the shipment whose invoice you want.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    generateInvoice: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Generate and retrieve all shipping labels for one or more packages in the shipment you specify.
+     * @param {string} shipmentId The ID of the shipment whose shipping labels you want to generate and retrieve.
+     * @param {GenerateShipLabelsOperationEnum} operation Specify whether you want to generate or regenerate a label.
+     * @param {string} [shippingOptionId] The ID of the shipping option whose shipping labels you want.
+     * @param {ShipLabelsInput} [body] Shipping details for when shipping is not done by the marketplace channel.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    generateShipLabels: (shipmentId: string, operation: GenerateShipLabelsOperationEnum, shippingOptionId?: string, body?: ShipLabelsInput, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a single shipment with the ID you specify.
+     * @param {string} shipmentId The ID of the shipment you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getShipment: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a list of shipments created for the seller in the status you specify. Shipments can be further filtered based on the fulfillment node or the time of the shipments\' last update.
+     * @param {GetShipmentsStatusEnum} status The status of shipment you want to include in the response. To retrieve all new shipments, set this value to &#x60;ACCEPTED&#x60;.
+     * @param {string} [locationId] The Amazon channel location identifier for the shipments you want to retrieve.
+     * @param {string} [marketplaceId] The marketplace ID associated with the location. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+     * @param {string} [channelName] The channel name associated with the location.
+     * @param {string} [lastUpdatedAfter] The response includes shipments whose latest update is after the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+     * @param {string} [lastUpdatedBefore] The response includes shipments whose latest update is before the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+     * @param {number} [maxResults] The maximum number of shipments to include in the response.
+     * @param {string} [paginationToken] A token that you use to retrieve the next page of results. The response includes &#x60;nextToken&#x60; when there are multiple pages of results. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getShipments: (status: GetShipmentsStatusEnum, locationId?: string, marketplaceId?: string, channelName?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, maxResults?: number, paginationToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Confirm or reject the specified shipment.
+     * @param {string} shipmentId The ID of the shipment you want to confirm or reject.
+     * @param {ProcessShipmentOperationEnum} operation The status of the shipment.
+     * @param {ShipmentAcknowledgementRequest} [body] Information about the shipment and its line items.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    processShipment: (shipmentId: string, operation: ProcessShipmentOperationEnum, body?: ShipmentAcknowledgementRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve invoices for the shipment you specify.
+     * @param {string} shipmentId The ID of the shipment whose invoice you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retrieveInvoice: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a list of shipping options for a package in a shipment given the shipment\'s marketplace and channel. If the marketplace and channel have a pre-determined shipping option, then this operation returns an empty response.
+     * @param {string} shipmentId The ID of the shipment to which the package belongs.
+     * @param {string} packageId The ID of the package for which you want to retrieve shipping options.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retrieveShippingOptions: (shipmentId: string, packageId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the details about the packages that will be used to fulfill the specified shipment.
+     * @param {string} shipmentId The ID of the shipment to which the package belongs.
+     * @param {string} packageId The ID of the package whose information you want to update.
+     * @param {Package} body The body of the request.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePackage: (shipmentId: string, packageId: string, body: Package, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the status of the packages.
+     * @param {string} shipmentId The ID of the shipment to which the package belongs.
+     * @param {string} packageId The ID of the package whose status you want to update.
+     * @param {UpdatePackageStatusStatusEnum} [status] **DEPRECATED**. Do not use. Package status is defined in the body parameter.
+     * @param {PackageDeliveryStatus} [body] The body of the request.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePackageStatus: (shipmentId: string, packageId: string, status?: UpdatePackageStatusStatusEnum, body?: PackageDeliveryStatus, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ExternalFulfillmentShipmentsApi - functional programming interface
+ */
+export declare const ExternalFulfillmentShipmentsApiFp: (configuration?: Configuration) => {
+    /**
+     * Provide details about the packages in the specified shipment.
+     * @param {string} shipmentId The ID of the shipment.
+     * @param {Packages} body A list of packages in the shipment.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPackages(shipmentId: string, body: Packages, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Get invoices for the shipment you specify.
+     * @param {string} shipmentId The ID of the shipment whose invoice you want.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    generateInvoice(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvoiceResponse>>;
+    /**
+     * Generate and retrieve all shipping labels for one or more packages in the shipment you specify.
+     * @param {string} shipmentId The ID of the shipment whose shipping labels you want to generate and retrieve.
+     * @param {GenerateShipLabelsOperationEnum} operation Specify whether you want to generate or regenerate a label.
+     * @param {string} [shippingOptionId] The ID of the shipping option whose shipping labels you want.
+     * @param {ShipLabelsInput} [body] Shipping details for when shipping is not done by the marketplace channel.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    generateShipLabels(shipmentId: string, operation: GenerateShipLabelsOperationEnum, shippingOptionId?: string, body?: ShipLabelsInput, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShipLabelsResponse>>;
+    /**
+     * Get a single shipment with the ID you specify.
+     * @param {string} shipmentId The ID of the shipment you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getShipment(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Shipment>>;
+    /**
+     * Get a list of shipments created for the seller in the status you specify. Shipments can be further filtered based on the fulfillment node or the time of the shipments\' last update.
+     * @param {GetShipmentsStatusEnum} status The status of shipment you want to include in the response. To retrieve all new shipments, set this value to &#x60;ACCEPTED&#x60;.
+     * @param {string} [locationId] The Amazon channel location identifier for the shipments you want to retrieve.
+     * @param {string} [marketplaceId] The marketplace ID associated with the location. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+     * @param {string} [channelName] The channel name associated with the location.
+     * @param {string} [lastUpdatedAfter] The response includes shipments whose latest update is after the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+     * @param {string} [lastUpdatedBefore] The response includes shipments whose latest update is before the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+     * @param {number} [maxResults] The maximum number of shipments to include in the response.
+     * @param {string} [paginationToken] A token that you use to retrieve the next page of results. The response includes &#x60;nextToken&#x60; when there are multiple pages of results. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getShipments(status: GetShipmentsStatusEnum, locationId?: string, marketplaceId?: string, channelName?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, maxResults?: number, paginationToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShipmentsResponse>>;
+    /**
+     * Confirm or reject the specified shipment.
+     * @param {string} shipmentId The ID of the shipment you want to confirm or reject.
+     * @param {ProcessShipmentOperationEnum} operation The status of the shipment.
+     * @param {ShipmentAcknowledgementRequest} [body] Information about the shipment and its line items.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    processShipment(shipmentId: string, operation: ProcessShipmentOperationEnum, body?: ShipmentAcknowledgementRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieve invoices for the shipment you specify.
+     * @param {string} shipmentId The ID of the shipment whose invoice you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retrieveInvoice(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvoiceResponse>>;
+    /**
+     * Get a list of shipping options for a package in a shipment given the shipment\'s marketplace and channel. If the marketplace and channel have a pre-determined shipping option, then this operation returns an empty response.
+     * @param {string} shipmentId The ID of the shipment to which the package belongs.
+     * @param {string} packageId The ID of the package for which you want to retrieve shipping options.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retrieveShippingOptions(shipmentId: string, packageId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShippingOptionsResponse>>;
+    /**
+     * Updates the details about the packages that will be used to fulfill the specified shipment.
+     * @param {string} shipmentId The ID of the shipment to which the package belongs.
+     * @param {string} packageId The ID of the package whose information you want to update.
+     * @param {Package} body The body of the request.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePackage(shipmentId: string, packageId: string, body: Package, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Updates the status of the packages.
+     * @param {string} shipmentId The ID of the shipment to which the package belongs.
+     * @param {string} packageId The ID of the package whose status you want to update.
+     * @param {UpdatePackageStatusStatusEnum} [status] **DEPRECATED**. Do not use. Package status is defined in the body parameter.
+     * @param {PackageDeliveryStatus} [body] The body of the request.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePackageStatus(shipmentId: string, packageId: string, status?: UpdatePackageStatusStatusEnum, body?: PackageDeliveryStatus, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * ExternalFulfillmentShipmentsApi - factory interface
+ */
+export declare const ExternalFulfillmentShipmentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Provide details about the packages in the specified shipment.
+     * @param {ExternalFulfillmentShipmentsApiCreatePackagesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPackages(requestParameters: ExternalFulfillmentShipmentsApiCreatePackagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Get invoices for the shipment you specify.
+     * @param {ExternalFulfillmentShipmentsApiGenerateInvoiceRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    generateInvoice(requestParameters: ExternalFulfillmentShipmentsApiGenerateInvoiceRequest, options?: RawAxiosRequestConfig): AxiosPromise<InvoiceResponse>;
+    /**
+     * Generate and retrieve all shipping labels for one or more packages in the shipment you specify.
+     * @param {ExternalFulfillmentShipmentsApiGenerateShipLabelsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    generateShipLabels(requestParameters: ExternalFulfillmentShipmentsApiGenerateShipLabelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShipLabelsResponse>;
+    /**
+     * Get a single shipment with the ID you specify.
+     * @param {ExternalFulfillmentShipmentsApiGetShipmentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getShipment(requestParameters: ExternalFulfillmentShipmentsApiGetShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Shipment>;
+    /**
+     * Get a list of shipments created for the seller in the status you specify. Shipments can be further filtered based on the fulfillment node or the time of the shipments\' last update.
+     * @param {ExternalFulfillmentShipmentsApiGetShipmentsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getShipments(requestParameters: ExternalFulfillmentShipmentsApiGetShipmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShipmentsResponse>;
+    /**
+     * Confirm or reject the specified shipment.
+     * @param {ExternalFulfillmentShipmentsApiProcessShipmentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    processShipment(requestParameters: ExternalFulfillmentShipmentsApiProcessShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Retrieve invoices for the shipment you specify.
+     * @param {ExternalFulfillmentShipmentsApiRetrieveInvoiceRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retrieveInvoice(requestParameters: ExternalFulfillmentShipmentsApiRetrieveInvoiceRequest, options?: RawAxiosRequestConfig): AxiosPromise<InvoiceResponse>;
+    /**
+     * Get a list of shipping options for a package in a shipment given the shipment\'s marketplace and channel. If the marketplace and channel have a pre-determined shipping option, then this operation returns an empty response.
+     * @param {ExternalFulfillmentShipmentsApiRetrieveShippingOptionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retrieveShippingOptions(requestParameters: ExternalFulfillmentShipmentsApiRetrieveShippingOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShippingOptionsResponse>;
+    /**
+     * Updates the details about the packages that will be used to fulfill the specified shipment.
+     * @param {ExternalFulfillmentShipmentsApiUpdatePackageRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePackage(requestParameters: ExternalFulfillmentShipmentsApiUpdatePackageRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Updates the status of the packages.
+     * @param {ExternalFulfillmentShipmentsApiUpdatePackageStatusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePackageStatus(requestParameters: ExternalFulfillmentShipmentsApiUpdatePackageStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * Request parameters for createPackages operation in ExternalFulfillmentShipmentsApi.
+ */
+export interface ExternalFulfillmentShipmentsApiCreatePackagesRequest {
+    /**
+     * The ID of the shipment.
+     */
+    readonly shipmentId: string;
+    /**
+     * A list of packages in the shipment.
+     */
+    readonly body: Packages;
+}
+/**
+ * Request parameters for generateInvoice operation in ExternalFulfillmentShipmentsApi.
+ */
+export interface ExternalFulfillmentShipmentsApiGenerateInvoiceRequest {
+    /**
+     * The ID of the shipment whose invoice you want.
+     */
+    readonly shipmentId: string;
+}
+/**
+ * Request parameters for generateShipLabels operation in ExternalFulfillmentShipmentsApi.
+ */
+export interface ExternalFulfillmentShipmentsApiGenerateShipLabelsRequest {
+    /**
+     * The ID of the shipment whose shipping labels you want to generate and retrieve.
+     */
+    readonly shipmentId: string;
+    /**
+     * Specify whether you want to generate or regenerate a label.
+     */
+    readonly operation: GenerateShipLabelsOperationEnum;
+    /**
+     * The ID of the shipping option whose shipping labels you want.
+     */
+    readonly shippingOptionId?: string;
+    /**
+     * Shipping details for when shipping is not done by the marketplace channel.
+     */
+    readonly body?: ShipLabelsInput;
+}
+/**
+ * Request parameters for getShipment operation in ExternalFulfillmentShipmentsApi.
+ */
+export interface ExternalFulfillmentShipmentsApiGetShipmentRequest {
+    /**
+     * The ID of the shipment you want to retrieve.
+     */
+    readonly shipmentId: string;
+}
+/**
+ * Request parameters for getShipments operation in ExternalFulfillmentShipmentsApi.
+ */
+export interface ExternalFulfillmentShipmentsApiGetShipmentsRequest {
+    /**
+     * The status of shipment you want to include in the response. To retrieve all new shipments, set this value to &#x60;ACCEPTED&#x60;.
+     */
+    readonly status: GetShipmentsStatusEnum;
+    /**
+     * The Amazon channel location identifier for the shipments you want to retrieve.
+     */
+    readonly locationId?: string;
+    /**
+     * The marketplace ID associated with the location. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+     */
+    readonly marketplaceId?: string;
+    /**
+     * The channel name associated with the location.
+     */
+    readonly channelName?: string;
+    /**
+     * The response includes shipments whose latest update is after the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+     */
+    readonly lastUpdatedAfter?: string;
+    /**
+     * The response includes shipments whose latest update is before the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+     */
+    readonly lastUpdatedBefore?: string;
+    /**
+     * The maximum number of shipments to include in the response.
+     */
+    readonly maxResults?: number;
+    /**
+     * A token that you use to retrieve the next page of results. The response includes &#x60;nextToken&#x60; when there are multiple pages of results. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
+     */
+    readonly paginationToken?: string;
+}
+/**
+ * Request parameters for processShipment operation in ExternalFulfillmentShipmentsApi.
+ */
+export interface ExternalFulfillmentShipmentsApiProcessShipmentRequest {
+    /**
+     * The ID of the shipment you want to confirm or reject.
+     */
+    readonly shipmentId: string;
+    /**
+     * The status of the shipment.
+     */
+    readonly operation: ProcessShipmentOperationEnum;
+    /**
+     * Information about the shipment and its line items.
+     */
+    readonly body?: ShipmentAcknowledgementRequest;
+}
+/**
+ * Request parameters for retrieveInvoice operation in ExternalFulfillmentShipmentsApi.
+ */
+export interface ExternalFulfillmentShipmentsApiRetrieveInvoiceRequest {
+    /**
+     * The ID of the shipment whose invoice you want to retrieve.
+     */
+    readonly shipmentId: string;
+}
+/**
+ * Request parameters for retrieveShippingOptions operation in ExternalFulfillmentShipmentsApi.
+ */
+export interface ExternalFulfillmentShipmentsApiRetrieveShippingOptionsRequest {
+    /**
+     * The ID of the shipment to which the package belongs.
+     */
+    readonly shipmentId: string;
+    /**
+     * The ID of the package for which you want to retrieve shipping options.
+     */
+    readonly packageId: string;
+}
+/**
+ * Request parameters for updatePackage operation in ExternalFulfillmentShipmentsApi.
+ */
+export interface ExternalFulfillmentShipmentsApiUpdatePackageRequest {
+    /**
+     * The ID of the shipment to which the package belongs.
+     */
+    readonly shipmentId: string;
+    /**
+     * The ID of the package whose information you want to update.
+     */
+    readonly packageId: string;
+    /**
+     * The body of the request.
+     */
+    readonly body: Package;
+}
+/**
+ * Request parameters for updatePackageStatus operation in ExternalFulfillmentShipmentsApi.
+ */
+export interface ExternalFulfillmentShipmentsApiUpdatePackageStatusRequest {
+    /**
+     * The ID of the shipment to which the package belongs.
+     */
+    readonly shipmentId: string;
+    /**
+     * The ID of the package whose status you want to update.
+     */
+    readonly packageId: string;
+    /**
+     * **DEPRECATED**. Do not use. Package status is defined in the body parameter.
+     */
+    readonly status?: UpdatePackageStatusStatusEnum;
+    /**
+     * The body of the request.
+     */
+    readonly body?: PackageDeliveryStatus;
+}
+/**
+ * ExternalFulfillmentShipmentsApi - object-oriented interface
+ */
+export declare class ExternalFulfillmentShipmentsApi extends BaseAPI {
+    /**
+     * Provide details about the packages in the specified shipment.
+     * @param {ExternalFulfillmentShipmentsApiCreatePackagesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPackages(requestParameters: ExternalFulfillmentShipmentsApiCreatePackagesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
+    /**
+     * Get invoices for the shipment you specify.
+     * @param {ExternalFulfillmentShipmentsApiGenerateInvoiceRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    generateInvoice(requestParameters: ExternalFulfillmentShipmentsApiGenerateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<InvoiceResponse, any, {}>>;
+    /**
+     * Generate and retrieve all shipping labels for one or more packages in the shipment you specify.
+     * @param {ExternalFulfillmentShipmentsApiGenerateShipLabelsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    generateShipLabels(requestParameters: ExternalFulfillmentShipmentsApiGenerateShipLabelsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShipLabelsResponse, any, {}>>;
+    /**
+     * Get a single shipment with the ID you specify.
+     * @param {ExternalFulfillmentShipmentsApiGetShipmentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getShipment(requestParameters: ExternalFulfillmentShipmentsApiGetShipmentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Shipment, any, {}>>;
+    /**
+     * Get a list of shipments created for the seller in the status you specify. Shipments can be further filtered based on the fulfillment node or the time of the shipments\' last update.
+     * @param {ExternalFulfillmentShipmentsApiGetShipmentsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getShipments(requestParameters: ExternalFulfillmentShipmentsApiGetShipmentsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShipmentsResponse, any, {}>>;
+    /**
+     * Confirm or reject the specified shipment.
+     * @param {ExternalFulfillmentShipmentsApiProcessShipmentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    processShipment(requestParameters: ExternalFulfillmentShipmentsApiProcessShipmentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
+    /**
+     * Retrieve invoices for the shipment you specify.
+     * @param {ExternalFulfillmentShipmentsApiRetrieveInvoiceRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retrieveInvoice(requestParameters: ExternalFulfillmentShipmentsApiRetrieveInvoiceRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<InvoiceResponse, any, {}>>;
+    /**
+     * Get a list of shipping options for a package in a shipment given the shipment\'s marketplace and channel. If the marketplace and channel have a pre-determined shipping option, then this operation returns an empty response.
+     * @param {ExternalFulfillmentShipmentsApiRetrieveShippingOptionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retrieveShippingOptions(requestParameters: ExternalFulfillmentShipmentsApiRetrieveShippingOptionsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShippingOptionsResponse, any, {}>>;
+    /**
+     * Updates the details about the packages that will be used to fulfill the specified shipment.
+     * @param {ExternalFulfillmentShipmentsApiUpdatePackageRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePackage(requestParameters: ExternalFulfillmentShipmentsApiUpdatePackageRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
+    /**
+     * Updates the status of the packages.
+     * @param {ExternalFulfillmentShipmentsApiUpdatePackageStatusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePackageStatus(requestParameters: ExternalFulfillmentShipmentsApiUpdatePackageStatusRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
+}
+export declare const GenerateShipLabelsOperationEnum: {
+    readonly Generate: "GENERATE";
+    readonly Regenerate: "REGENERATE";
+};
+export type GenerateShipLabelsOperationEnum = typeof GenerateShipLabelsOperationEnum[keyof typeof GenerateShipLabelsOperationEnum];
+export declare const GetShipmentsStatusEnum: {
+    readonly Created: "CREATED";
+    readonly Accepted: "ACCEPTED";
+    readonly Confirmed: "CONFIRMED";
+    readonly PackageCreated: "PACKAGE_CREATED";
+    readonly PickupSlotRetrieved: "PICKUP_SLOT_RETRIEVED";
+    readonly InvoiceGenerated: "INVOICE_GENERATED";
+    readonly ShiplabelGenerated: "SHIPLABEL_GENERATED";
+    readonly Cancelled: "CANCELLED";
+    readonly Shipped: "SHIPPED";
+    readonly Delivered: "DELIVERED";
+};
+export type GetShipmentsStatusEnum = typeof GetShipmentsStatusEnum[keyof typeof GetShipmentsStatusEnum];
+export declare const ProcessShipmentOperationEnum: {
+    readonly Confirm: "CONFIRM";
+    readonly Reject: "REJECT";
+};
+export type ProcessShipmentOperationEnum = typeof ProcessShipmentOperationEnum[keyof typeof ProcessShipmentOperationEnum];
+export declare const UpdatePackageStatusStatusEnum: {
+    readonly Shipped: "SHIPPED";
+};
+export type UpdatePackageStatusStatusEnum = typeof UpdatePackageStatusStatusEnum[keyof typeof UpdatePackageStatusStatusEnum];