Function ExternalFulfillmentShipmentsApiAxiosParamCreator

Returns {
    createPackages: (
        shipmentId: string,
        body: Packages,
        options?: RawAxiosRequestConfig,
    ) => Promise<RequestArgs>;
    createSandboxShipment: (
        body: CreateSandboxShipmentRequest,
        options?: RawAxiosRequestConfig,
    ) => Promise<RequestArgs>;
    generateInvoice: (
        shipmentId: string,
        options?: RawAxiosRequestConfig,
    ) => Promise<RequestArgs>;
    generateShipLabels: (
        shipmentId: string,
        operation: GenerateShipLabelsOperationEnum,
        shippingOptionId?: string,
        body?: ShipLabelsInput,
        options?: RawAxiosRequestConfig,
    ) => Promise<RequestArgs>;
    getShipment: (
        shipmentId: string,
        options?: RawAxiosRequestConfig,
    ) => Promise<RequestArgs>;
    getShipments: (
        status: GetShipmentsStatusEnum,
        locationId?: string,
        marketplaceId?: string,
        channelName?: string,
        lastUpdatedAfter?: string,
        lastUpdatedBefore?: string,
        maxResults?: number,
        paginationToken?: string,
        options?: RawAxiosRequestConfig,
    ) => Promise<RequestArgs>;
    processShipment: (
        shipmentId: string,
        operation: ProcessShipmentOperationEnum,
        body?: ShipmentAcknowledgementRequest,
        options?: RawAxiosRequestConfig,
    ) => Promise<RequestArgs>;
    retrieveInvoice: (
        shipmentId: string,
        options?: RawAxiosRequestConfig,
    ) => Promise<RequestArgs>;
    retrieveShippingOptions: (
        shipmentId: string,
        packageId: string,
        options?: RawAxiosRequestConfig,
    ) => Promise<RequestArgs>;
    updatePackage: (
        shipmentId: string,
        packageId: string,
        body: Package,
        options?: RawAxiosRequestConfig,
    ) => Promise<RequestArgs>;
    updatePackageStatus: (
        shipmentId: string,
        packageId: string,
        status?: "SHIPPED",
        body?: PackageDeliveryStatus,
        options?: RawAxiosRequestConfig,
    ) => Promise<RequestArgs>;
    updateSandboxShipment: (
        shipmentId: string,
        body: UpdateSandboxShipmentRequest,
        options?: RawAxiosRequestConfig,
    ) => Promise<RequestArgs>;
}

• createPackages: (
      shipmentId: string,
      body: Packages,
      options?: RawAxiosRequestConfig,
  ) => Promise<RequestArgs>

  Provide details about the packages in the specified shipment.

  Throws

• createSandboxShipment: (
      body: CreateSandboxShipmentRequest,
      options?: RawAxiosRequestConfig,
  ) => Promise<RequestArgs>

  Creates a sandbox shipment to simulate order creation in the test environment. This operation is available only in the sandbox environment. The shipment is created with the specified configuration including shipping type and order type.

  Throws

• generateInvoice: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

  Get invoices for the shipment you specify.

  Throws

• generateShipLabels: (
      shipmentId: string,
      operation: GenerateShipLabelsOperationEnum,
      shippingOptionId?: string,
      body?: ShipLabelsInput,
      options?: RawAxiosRequestConfig,
  ) => Promise<RequestArgs>

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

  Throws

• getShipment: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

  Get a single shipment with the ID you specify.

  Throws

• getShipments: (
      status: GetShipmentsStatusEnum,
      locationId?: string,
      marketplaceId?: string,
      channelName?: string,
      lastUpdatedAfter?: string,
      lastUpdatedBefore?: string,
      maxResults?: number,
      paginationToken?: 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.

  Throws

• processShipment: (
      shipmentId: string,
      operation: ProcessShipmentOperationEnum,
      body?: ShipmentAcknowledgementRequest,
      options?: RawAxiosRequestConfig,
  ) => Promise<RequestArgs>

  Confirm or reject the specified shipment.

  Throws

• retrieveInvoice: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

  Retrieve invoices for the shipment you specify.

  Throws

• retrieveShippingOptions: (
      shipmentId: string,
      packageId: 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.

  Throws

• updatePackage: (
      shipmentId: string,
      packageId: string,
      body: Package,
      options?: RawAxiosRequestConfig,
  ) => Promise<RequestArgs>

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

  Throws

• updatePackageStatus: (
      shipmentId: string,
      packageId: string,
      status?: "SHIPPED",
      body?: PackageDeliveryStatus,
      options?: RawAxiosRequestConfig,
  ) => Promise<RequestArgs>

  Updates the status of the packages.

  Throws

• updateSandboxShipment: (
      shipmentId: string,
      body: UpdateSandboxShipmentRequest,
      options?: RawAxiosRequestConfig,
  ) => Promise<RequestArgs>

  Updates a sandbox shipment on marketplace behalf. Supports status changes, invoice availability, and transport capacity updates.

  Throws