Function VendorOrdersApiAxiosParamCreator

VendorOrdersApi - axios parameter creator

Export

  • VendorOrdersApiAxiosParamCreator(
        configuration?: Configuration,
    ): {
        getOrder: (
            purchaseOrderNumber: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getOrders: (
            createdAfter: string,
            createdBefore: string,
            shipFromPartyId?: string,
            status?: GetOrdersStatusEnum,
            limit?: number,
            sortOrder?: GetOrdersSortOrderEnum,
            nextToken?: string,
            includeDetails?: boolean,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        submitAcknowledgement: (
            body: SubmitAcknowledgementRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        getOrder: (
            purchaseOrderNumber: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getOrders: (
            createdAfter: string,
            createdBefore: string,
            shipFromPartyId?: string,
            status?: GetOrdersStatusEnum,
            limit?: number,
            sortOrder?: GetOrdersSortOrderEnum,
            nextToken?: string,
            includeDetails?: boolean,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        submitAcknowledgement: (
            body: SubmitAcknowledgementRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

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

      Returns purchase order information for the purchaseOrderNumber that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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 then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

      Throws

    • getOrders: (
          createdAfter: string,
          createdBefore: string,
          shipFromPartyId?: string,
          status?: GetOrdersStatusEnum,
          limit?: number,
          sortOrder?: GetOrdersSortOrderEnum,
          nextToken?: string,
          includeDetails?: boolean,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Returns a list of purchase orders created during the time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both parameters. You can choose to get only the purchase order numbers by setting the includeDetails parameter to false. In that case, the operation returns a list of purchase order numbers. You can then call the getOrder operation to return the details of a specific order. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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 then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

      Throws

    • submitAcknowledgement: (
          body: SubmitAcknowledgementRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Submits acknowledgements for one or more purchase orders. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | 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 then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

      Throws

Settings

Member Visibility