Function OrdersApiAxiosParamCreator

OrdersApi - axios parameter creator

Export

  • OrdersApiAxiosParamCreator(
        configuration?: Configuration,
    ): {
        confirmShipment: (
            orderId: string,
            payload: ConfirmShipmentRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getOrder: (
            orderId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getOrderAddress: (
            orderId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getOrderBuyerInfo: (
            orderId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getOrderItems: (
            orderId: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getOrderItemsBuyerInfo: (
            orderId: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getOrderRegulatedInfo: (
            orderId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getOrders: (
            marketplaceIds: string[],
            createdAfter?: string,
            createdBefore?: string,
            lastUpdatedAfter?: string,
            lastUpdatedBefore?: string,
            orderStatuses?: string[],
            fulfillmentChannels?: string[],
            paymentMethods?: string[],
            buyerEmail?: string,
            sellerOrderId?: string,
            maxResultsPerPage?: number,
            easyShipShipmentStatuses?: string[],
            electronicInvoiceStatuses?: string[],
            nextToken?: string,
            amazonOrderIds?: string[],
            actualFulfillmentSupplySourceId?: string,
            isISPU?: boolean,
            storeChainStoreId?: string,
            earliestDeliveryDateBefore?: string,
            earliestDeliveryDateAfter?: string,
            latestDeliveryDateBefore?: string,
            latestDeliveryDateAfter?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        updateShipmentStatus: (
            orderId: string,
            payload: UpdateShipmentStatusRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        updateVerificationStatus: (
            orderId: string,
            payload: UpdateVerificationStatusRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        confirmShipment: (
            orderId: string,
            payload: ConfirmShipmentRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getOrder: (
            orderId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getOrderAddress: (
            orderId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getOrderBuyerInfo: (
            orderId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getOrderItems: (
            orderId: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getOrderItemsBuyerInfo: (
            orderId: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getOrderRegulatedInfo: (
            orderId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getOrders: (
            marketplaceIds: string[],
            createdAfter?: string,
            createdBefore?: string,
            lastUpdatedAfter?: string,
            lastUpdatedBefore?: string,
            orderStatuses?: string[],
            fulfillmentChannels?: string[],
            paymentMethods?: string[],
            buyerEmail?: string,
            sellerOrderId?: string,
            maxResultsPerPage?: number,
            easyShipShipmentStatuses?: string[],
            electronicInvoiceStatuses?: string[],
            nextToken?: string,
            amazonOrderIds?: string[],
            actualFulfillmentSupplySourceId?: string,
            isISPU?: boolean,
            storeChainStoreId?: string,
            earliestDeliveryDateBefore?: string,
            earliestDeliveryDateAfter?: string,
            latestDeliveryDateBefore?: string,
            latestDeliveryDateAfter?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        updateShipmentStatus: (
            orderId: string,
            payload: UpdateShipmentStatusRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        updateVerificationStatus: (
            orderId: string,
            payload: UpdateVerificationStatusRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

    • confirmShipment: (
          orderId: string,
          payload: ConfirmShipmentRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Updates the shipment confirmation status for a specified order. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | 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 contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to Usage Plans and Rate Limits.

      Throws

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

      Returns the order that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to Usage Plans and Rate Limits.

      Throws

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

      Returns the shipping address for the order that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to Usage Plans and Rate Limits.

      Throws

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

      Returns buyer information for the order that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to Usage Plans and Rate Limits.

      Throws

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

      Returns detailed order item information for the order that you specify. If NextToken is provided, it's used to retrieve the next page of order items. Note: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to Usage Plans and Rate Limits.

      Throws

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

      Returns buyer information for the order items in the order that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to Usage Plans and Rate Limits.

      Throws

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

      Returns regulated information for the order that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to Usage Plans and Rate Limits.

      Throws

    • getOrders: (
          marketplaceIds: string[],
          createdAfter?: string,
          createdBefore?: string,
          lastUpdatedAfter?: string,
          lastUpdatedBefore?: string,
          orderStatuses?: string[],
          fulfillmentChannels?: string[],
          paymentMethods?: string[],
          buyerEmail?: string,
          sellerOrderId?: string,
          maxResultsPerPage?: number,
          easyShipShipmentStatuses?: string[],
          electronicInvoiceStatuses?: string[],
          nextToken?: string,
          amazonOrderIds?: string[],
          actualFulfillmentSupplySourceId?: string,
          isISPU?: boolean,
          storeChainStoreId?: string,
          earliestDeliveryDateBefore?: string,
          earliestDeliveryDateAfter?: string,
          latestDeliveryDateBefore?: string,
          latestDeliveryDateAfter?: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. NextToken doesn't affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API documentation.

      Throws

    • updateShipmentStatus: (
          orderId: string,
          payload: UpdateShipmentStatusRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Update the shipment status for an order that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | 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 contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to Usage Plans and Rate Limits.

      Throws

    • updateVerificationStatus: (
          orderId: string,
          payload: UpdateVerificationStatusRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Updates (approves or rejects) the verification status of an order containing regulated products. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to Usage Plans and Rate Limits.

      Throws

Settings

Member Visibility