Selling Partner API SDK for JavaScript
    Preparing search index...

    Function AmazonWarehousingAndDistributionApiAxiosParamCreator

    • AmazonWarehousingAndDistributionApi - axios parameter creator

      Parameters

      • Optionalconfiguration: Configuration

      Returns {
          cancelInbound: (
              orderId: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          checkInboundEligibility: (
              body: InboundPackages,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          confirmInbound: (
              orderId: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          confirmOutbound: (
              orderId: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          confirmReplenishmentOrder: (
              orderId: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          createInbound: (
              body: InboundOrderCreationData,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          createOutbound: (
              body: OutboundOrderCreationData,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          createReplenishmentOrder: (
              body: ReplenishmentOrderCreationData,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getInbound: (
              orderId: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getInboundShipment: (
              shipmentId: string,
              skuQuantities?: GetInboundShipmentSkuQuantitiesEnum,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getInboundShipmentLabels: (
              shipmentId: string,
              pageType?: "PLAIN_PAPER",
              formatType?: "PDF",
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getLabelPageTypes: (
              shipmentId: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getOutbound: (
              orderId: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          getReplenishmentOrder: (
              orderId: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          listInboundShipments: (
              sortBy?: ListInboundShipmentsSortByEnum,
              sortOrder?: ListInboundShipmentsSortOrderEnum,
              shipmentStatus?: ListInboundShipmentsShipmentStatusEnum,
              updatedAfter?: string,
              updatedBefore?: string,
              maxResults?: number,
              nextToken?: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          listInventory: (
              sku?: string,
              sortOrder?: ListInventorySortOrderEnum,
              details?: ListInventoryDetailsEnum,
              nextToken?: string,
              maxResults?: number,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          listOutbounds: (
              updatedAfter?: string,
              updatedBefore?: string,
              sortOrder?: ListOutboundsSortOrderEnum,
              maxResults?: number,
              nextToken?: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          listReplenishmentOrders: (
              updatedAfter?: string,
              updatedBefore?: string,
              sortOrder?: ListReplenishmentOrdersSortOrderEnum,
              maxResults?: number,
              nextToken?: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          updateInbound: (
              orderId: string,
              body: InboundOrder,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          updateInboundShipmentTransportDetails: (
              shipmentId: string,
              body: TransportationDetails,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          updateOutbound: (
              orderId: string,
              body: OutboundOrder,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
      }

      • cancelInbound: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        Cancels an AWD Inbound order and its associated shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

      • checkInboundEligibility: (body: InboundPackages, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        Determines if the packages you specify are eligible for an AWD inbound order and contains error details for ineligible packages. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

      • confirmInbound: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        Confirms an AWD inbound order in DRAFT status. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

      • confirmOutbound: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        Confirms an AWD outbound order for a set of shipments that contain items that must be outbound to a destination node. You can confirm the order only if it's in anELIGIBLE state. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

      • confirmReplenishmentOrder: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        Confirms an AWD replenishment order in ELIGIBLE state with a set of shipments containing items that are needed to be replenished to an FBA node. Order can only be confirmed in ELIGIBLE state.

      • createInbound: (
            body: InboundOrderCreationData,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Creates a draft AWD inbound order with a list of packages for inbound shipment. The operation creates one shipment per order. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

      • createOutbound: (
            body: OutboundOrderCreationData,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Creates a draft AWD outbound order with the specified products. The API returns the order ID for the newly created order and starts an async validation check on the outbound products. After the validation check, the order status transitions from VALIDATING to ELIGIBLE/INELIGIBLE. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

      • createReplenishmentOrder: (
            body: ReplenishmentOrderCreationData,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Creates an AWD replenishment order with given products to replenish. The API will return the order ID of the newly created order and also start an async validation check on the products to e. The order status will transition to ELIGIBLE/INELIGIBLE status from VALIDATING post validation check

      • getInbound: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        Retrieves an AWD inbound order. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

      • getInboundShipment: (
            shipmentId: string,
            skuQuantities?: GetInboundShipmentSkuQuantitiesEnum,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retrieves an AWD inbound shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API

      • getInboundShipmentLabels: (
            shipmentId: string,
            pageType?: "PLAIN_PAPER",
            formatType?: "PDF",
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retrieves the box labels for a shipment ID that you specify. This is an asynchronous operation. If the label status is GENERATED, then the label URL is available. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

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

        Retrieves the available label page types for a shipment ID that you specify. This is an asynchronous operation. If the label status is GENERATED, then the pageTypes are available. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

      • getOutbound: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        Retrieves an AWD outbound order with a set of shipments that contain items that are outbound into a destination channel. If the order is not eligible, the validation errors field is included in the order response. The API returns the order ID for the newly created order and starts an async validation check on the outbound products. After the validation check, the order status transitions from VALIDATING to ELIGIBLE/INELIGIBLE. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

      • getReplenishmentOrder: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        Retrieves an AWD Replenishment order with a set of shipments containing items that is/was planned to be replenished into an FBA node.

      • listInboundShipments: (
            sortBy?: ListInboundShipmentsSortByEnum,
            sortOrder?: ListInboundShipmentsSortOrderEnum,
            shipmentStatus?: ListInboundShipmentsShipmentStatusEnum,
            updatedAfter?: string,
            updatedBefore?: string,
            maxResults?: number,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

      • listInventory: (
            sku?: string,
            sortOrder?: ListInventorySortOrderEnum,
            details?: ListInventoryDetailsEnum,
            nextToken?: string,
            maxResults?: number,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Lists AWD inventory associated with a merchant with the ability to apply optional filters. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

      • listOutbounds: (
            updatedAfter?: string,
            updatedBefore?: string,
            sortOrder?: ListOutboundsSortOrderEnum,
            maxResults?: number,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retrieves all outbound AWD orders (with optional filters) that pertain to a merchant. By default, orders are sorted by the updatedAt attribute in descending order. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

      • listReplenishmentOrders: (
            updatedAfter?: string,
            updatedBefore?: string,
            sortOrder?: ListReplenishmentOrdersSortOrderEnum,
            maxResults?: number,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Retrieves all the AWD replenishment orders pertaining to a merchant with optional filters. API by default will sort orders by updatedAt attribute in descending order.

      • updateInbound: (
            orderId: string,
            body: InboundOrder,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Updates an AWD inbound order that is in DRAFT status and not yet confirmed. Use this operation to update the packagesToInbound, originAddress and preferences attributes. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

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

        Updates transport details for an AWD shipment. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

      • updateOutbound: (
            orderId: string,
            body: OutboundOrder,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Updates an AWD outbound order that is in DRAFT, ELIGIBLE, or INELIGIBLE status. This API allows updates on productsToOutbound and orderPreferences attributes only. Any updates will restart the outbound order validation. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

    Settings

    Member Visibility