Class: Peddler::APIs::VendorDirectFulfillmentTransactionsV1

Inherits:
Peddler::API
  • Object
show all
Defined in:
lib/peddler/apis/vendor_direct_fulfillment_transactions_v1.rb,
lib/peddler/apis/vendor_direct_fulfillment_transactions_v1/error.rb,
lib/peddler/apis/vendor_direct_fulfillment_transactions_v1/error_list.rb,
lib/peddler/apis/vendor_direct_fulfillment_transactions_v1/transaction.rb,
lib/peddler/apis/vendor_direct_fulfillment_transactions_v1/transaction_status.rb,
lib/peddler/apis/vendor_direct_fulfillment_transactions_v1/get_transaction_response.rb,
sig/peddler/apis/vendor_direct_fulfillment_transactions_v1.rbs

Overview

Selling Partner API for Direct Fulfillment Transaction Status

The Selling Partner API for Direct Fulfillment Transaction Status provides programmatic access to a direct fulfillment vendor's transaction status.

Defined Under Namespace

Classes: Error, ErrorList, GetTransactionResponse, Transaction, TransactionStatus

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint, #retries

Instance Method Summary collapse

Methods inherited from Peddler::API

#cannot_sandbox!, #delete, #endpoint_uri, #get, #http, #initialize, #must_sandbox!, #patch, #percent_encode, #post, #put, #request, #sandbox, #sandbox?, #stringify_array, #timestamp, #user_agent

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#get_transaction_status(transaction_id, rate_limit: 10.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns the status of the transaction indicated by the specified transactionId.

Parameters:

  • transaction_id (String)

    Previously returned in the response to the POST request of a specific transaction.

  • rate_limit (Float) (defaults to: 10.0)

    Requests per second

  • (String)
  • rate_limit: (Float) (defaults to: 10.0)

Returns:



21
22
23
24
25
# File 'lib/peddler/apis/vendor_direct_fulfillment_transactions_v1.rb', line 21

def get_transaction_status(transaction_id, rate_limit: 10.0)
  path = "/vendor/directFulfillment/transactions/v1/transactions/#{percent_encode(transaction_id)}"
  parser = -> { GetTransactionResponse }
  get(path, rate_limit:, parser:)
end