Function ExternalFulfillmentShipmentsApiFp

Returns {
    createPackages(
        shipmentId: string,
        body: Packages,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    generateInvoice(
        shipmentId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<InvoiceResponse>,
    >;
    generateShipLabels(
        shipmentId: string,
        operation: GenerateShipLabelsOperationEnum,
        shippingOptionId?: string,
        body?: ShipLabelsInput,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ShipLabelsResponse>,
    >;
    getShipment(
        shipmentId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Shipment>,
    >;
    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>,
    >;
    processShipment(
        shipmentId: string,
        operation: ProcessShipmentOperationEnum,
        body?: ShipmentAcknowledgementRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    retrieveInvoice(
        shipmentId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<InvoiceResponse>,
    >;
    retrieveShippingOptions(
        shipmentId: string,
        packageId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ShippingOptionsResponse>,
    >;
    updatePackage(
        shipmentId: string,
        packageId: string,
        body: Package,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    updatePackageStatus(
        shipmentId: string,
        packageId: string,
        status?: "SHIPPED",
        body?: PackageDeliveryStatus,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
}

• createPackages: function

  • createPackages(
        shipmentId: string,
        body: Packages,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Provide details about the packages in the specified shipment.

    Parameters

    • shipmentId: string

      The ID of the shipment.

    • body: Packages

      A list of packages in the shipment.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• generateInvoice: function

  • generateInvoice(
        shipmentId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<InvoiceResponse>,
    >

    Get invoices for the shipment you specify.

    Parameters

    • shipmentId: string

      The ID of the shipment whose invoice you want.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<InvoiceResponse>,
    >

    Throws

• generateShipLabels: function

  • generateShipLabels(
        shipmentId: string,
        operation: GenerateShipLabelsOperationEnum,
        shippingOptionId?: string,
        body?: ShipLabelsInput,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ShipLabelsResponse>,
    >

    Generate and retrieve all shipping labels for one or more packages in the shipment you specify.

    Parameters

    • shipmentId: string

      The ID of the shipment whose shipping labels you want to generate and retrieve.

    • operation: GenerateShipLabelsOperationEnum

      Specify whether you want to generate or regenerate a label.

    • OptionalshippingOptionId: string

      The ID of the shipping option whose shipping labels you want.

    • Optionalbody: ShipLabelsInput

      Shipping details for when shipping is not done by the marketplace channel.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ShipLabelsResponse>,
    >

    Throws

• getShipment: function

  • getShipment(
        shipmentId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Shipment>,
    >

    Get a single shipment with the ID you specify.

    Parameters

    • shipmentId: string

      The ID of the shipment you want to retrieve.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Shipment>>

    Throws

• getShipments: function

  • 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>,
    >

    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.

    Parameters

    • status: GetShipmentsStatusEnum

      The status of shipment you want to include in the response. To retrieve all new shipments, set this value to `CREATED` or `ACCEPTED`.

    • OptionallocationId: string

      The Amazon channel location identifier for the shipments you want to retrieve.

    • OptionalmarketplaceId: string

      The marketplace ID associated with the location. To find the ID for your marketplace, refer to Marketplace IDs.

    • OptionalchannelName: string

      The channel name associated with the location.

    • OptionallastUpdatedAfter: string

      The response includes shipments whose latest update is after the specified time. In ISO 8601 date-time format.

    • OptionallastUpdatedBefore: string

      The response includes shipments whose latest update is before the specified time. In ISO 8601 date-time format.

    • OptionalmaxResults: number

      The maximum number of shipments to include in the response.

    • OptionalpaginationToken: string

      A token that you use to retrieve the next page of results. The response includes `nextToken` 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 `nextToken` is null. Note that this operation can return empty pages.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ShipmentsResponse>,
    >

    Throws

• processShipment: function

  • processShipment(
        shipmentId: string,
        operation: ProcessShipmentOperationEnum,
        body?: ShipmentAcknowledgementRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Confirm or reject the specified shipment.

    Parameters

    • shipmentId: string

      The ID of the shipment you want to confirm or reject.

    • operation: ProcessShipmentOperationEnum

      The status of the shipment.

    • Optionalbody: ShipmentAcknowledgementRequest

      Information about the shipment and its line items.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• retrieveInvoice: function

  • retrieveInvoice(
        shipmentId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<InvoiceResponse>,
    >

    Retrieve invoices for the shipment you specify.

    Parameters

    • shipmentId: string

      The ID of the shipment whose invoice you want to retrieve.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<InvoiceResponse>,
    >

    Throws

• retrieveShippingOptions: function

  • retrieveShippingOptions(
        shipmentId: string,
        packageId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ShippingOptionsResponse>,
    >

    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.

    Parameters

    • shipmentId: string

      The ID of the shipment to which the package belongs.

    • packageId: string

      The ID of the package for which you want to retrieve shipping options.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ShippingOptionsResponse>,
    >

    Throws

• updatePackage: function

  • updatePackage(
        shipmentId: string,
        packageId: string,
        body: Package,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Updates the details about the packages that will be used to fulfill the specified shipment.

    Parameters

    • shipmentId: string

      The ID of the shipment to which the package belongs.

    • packageId: string

      The ID of the package whose information you want to update.

    • body: Package

      The body of the request.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• updatePackageStatus: function

  • updatePackageStatus(
        shipmentId: string,
        packageId: string,
        status?: "SHIPPED",
        body?: PackageDeliveryStatus,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Updates the status of the packages.

    Parameters

    • shipmentId: string

      The ID of the shipment to which the package belongs.

    • packageId: string

      The ID of the package whose status you want to update.

    • Optionalstatus: "SHIPPED"

      DEPRECATED. Do not use. Package status is defined in the body parameter.

    • Optionalbody: PackageDeliveryStatus

      The body of the request.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws