Function ExternalFulfillmentShipmentsApiFactory

Returns {
    createPackages(
        requestParameters: ExternalFulfillmentShipmentsApiCreatePackagesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    generateInvoice(
        requestParameters: ExternalFulfillmentShipmentsApiGenerateInvoiceRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<InvoiceResponse>;
    generateShipLabels(
        requestParameters: ExternalFulfillmentShipmentsApiGenerateShipLabelsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShipLabelsResponse>;
    getShipment(
        requestParameters: ExternalFulfillmentShipmentsApiGetShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<Shipment>;
    getShipments(
        requestParameters: ExternalFulfillmentShipmentsApiGetShipmentsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShipmentsResponse>;
    processShipment(
        requestParameters: ExternalFulfillmentShipmentsApiProcessShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    retrieveInvoice(
        requestParameters: ExternalFulfillmentShipmentsApiRetrieveInvoiceRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<InvoiceResponse>;
    retrieveShippingOptions(
        requestParameters: ExternalFulfillmentShipmentsApiRetrieveShippingOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShippingOptionsResponse>;
    updatePackage(
        requestParameters: ExternalFulfillmentShipmentsApiUpdatePackageRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    updatePackageStatus(
        requestParameters: ExternalFulfillmentShipmentsApiUpdatePackageStatusRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
}

• createPackages: function

  • createPackages(
        requestParameters: ExternalFulfillmentShipmentsApiCreatePackagesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Provide details about the packages in the specified shipment.

    Parameters

    • requestParameters: ExternalFulfillmentShipmentsApiCreatePackagesRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• generateInvoice: function

  • generateInvoice(
        requestParameters: ExternalFulfillmentShipmentsApiGenerateInvoiceRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<InvoiceResponse>

    Get invoices for the shipment you specify.

    Parameters

    • requestParameters: ExternalFulfillmentShipmentsApiGenerateInvoiceRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<InvoiceResponse>

    Throws

• generateShipLabels: function

  • generateShipLabels(
        requestParameters: ExternalFulfillmentShipmentsApiGenerateShipLabelsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShipLabelsResponse>

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

    Parameters

    • requestParameters: ExternalFulfillmentShipmentsApiGenerateShipLabelsRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ShipLabelsResponse>

    Throws

• getShipment: function

  • getShipment(
        requestParameters: ExternalFulfillmentShipmentsApiGetShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<Shipment>

    Get a single shipment with the ID you specify.

    Parameters

    • requestParameters: ExternalFulfillmentShipmentsApiGetShipmentRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<Shipment>

    Throws

• getShipments: function

  • getShipments(
        requestParameters: ExternalFulfillmentShipmentsApiGetShipmentsRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: ExternalFulfillmentShipmentsApiGetShipmentsRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ShipmentsResponse>

    Throws

• processShipment: function

  • processShipment(
        requestParameters: ExternalFulfillmentShipmentsApiProcessShipmentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Confirm or reject the specified shipment.

    Parameters

    • requestParameters: ExternalFulfillmentShipmentsApiProcessShipmentRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• retrieveInvoice: function

  • retrieveInvoice(
        requestParameters: ExternalFulfillmentShipmentsApiRetrieveInvoiceRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<InvoiceResponse>

    Retrieve invoices for the shipment you specify.

    Parameters

    • requestParameters: ExternalFulfillmentShipmentsApiRetrieveInvoiceRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<InvoiceResponse>

    Throws

• retrieveShippingOptions: function

  • retrieveShippingOptions(
        requestParameters: ExternalFulfillmentShipmentsApiRetrieveShippingOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: ExternalFulfillmentShipmentsApiRetrieveShippingOptionsRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ShippingOptionsResponse>

    Throws

• updatePackage: function

  • updatePackage(
        requestParameters: ExternalFulfillmentShipmentsApiUpdatePackageRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

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

    Parameters

    • requestParameters: ExternalFulfillmentShipmentsApiUpdatePackageRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• updatePackageStatus: function

  • updatePackageStatus(
        requestParameters: ExternalFulfillmentShipmentsApiUpdatePackageStatusRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Updates the status of the packages.

    Parameters

    • requestParameters: ExternalFulfillmentShipmentsApiUpdatePackageStatusRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws