Class: Peddler::API::VendorDirectFulfillmentOrders20211228

Inherits:
Peddler::API
  • Object
show all
Defined in:
lib/peddler/api/vendor_direct_fulfillment_orders_2021_12_28.rb

Overview

Selling Partner API for Direct Fulfillment Orders

The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor’s order data.

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint

Instance Method Summary collapse

Methods inherited from Peddler::API

#cannot_sandbox!, #endpoint_uri, #http, #initialize, #meter, #must_sandbox!, #retriable, #sandbox, #sandbox?, #use, #via

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#get_order(purchase_order_number, rate_limit: 10.0) ⇒ Hash

Note:

This operation can make a dynamic sandbox call.

Returns purchase order information for the purchaseOrderNumber that you specify.



65
66
67
68
69
 
# File 'lib/peddler/api/vendor_direct_fulfillment_orders_2021_12_28.rb', line 65

def get_order(purchase_order_number, rate_limit: 10.0)
  path = "/vendor/directFulfillment/orders/2021-12-28/purchaseOrders/#{purchase_order_number}"

  meter(rate_limit).get(path)
end

#get_orders(created_after, created_before, ship_from_party_id: nil, status: nil, limit: nil, sort_order: nil, next_token: nil, include_details: "true", rate_limit: 10.0) ⇒ Hash

Note:

This operation can make a dynamic sandbox call.

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.



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/peddler/api/vendor_direct_fulfillment_orders_2021_12_28.rb', line 41

def get_orders(created_after, created_before, ship_from_party_id: nil, status: nil, limit: nil, sort_order: nil,
  next_token: nil, include_details: "true", rate_limit: 10.0)
  path = "/vendor/directFulfillment/orders/2021-12-28/purchaseOrders"
  params = {
    "shipFromPartyId" => ship_from_party_id,
    "status" => status,
    "limit" => limit,
    "createdAfter" => created_after,
    "createdBefore" => created_before,
    "sortOrder" => sort_order,
    "nextToken" => next_token,
    "includeDetails" => include_details,
  }.compact

  meter(rate_limit).get(path, params:)
end

#submit_acknowledgement(body, rate_limit: 10.0) ⇒ Hash

Note:

This operation can make a dynamic sandbox call.

Submits acknowledgements for one or more purchase orders.



77
78
79
80
81
 
# File 'lib/peddler/api/vendor_direct_fulfillment_orders_2021_12_28.rb', line 77

def submit_acknowledgement(body, rate_limit: 10.0)
  path = "/vendor/directFulfillment/orders/2021-12-28/acknowledgements"

  meter(rate_limit).post(path, body:)
end