Class: Peddler::APIs::OrdersV0

Inherits:
Peddler::API show all
Defined in:
lib/peddler/apis/orders_v0.rb

Overview

Selling Partner API for Orders

Use the Orders Selling Partner API to programmatically retrieve order information. With this API, you can develop fast, flexible, and custom applications to manage order synchronization, perform order research, and create demand-based decision support tools.

Note: For the JP, AU, and SG marketplaces, the Orders API supports orders from 2016 onward. For all other marketplaces, the Orders API supports orders for the last two years (orders older than this don’t show up in the response).

See Also:

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint, #retries

Instance Method Summary collapse

Methods inherited from Peddler::API

#endpoint_uri, #http, #initialize, #meter, #retriable, #sandbox, #sandbox?, #typed, #typed?, #use, #via

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#confirm_shipment(order_id, payload, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Updates the shipment confirmation status for a specified order.

Parameters:

  • order_id (String) —

    An Amazon-defined order identifier, in 3-7-7 format.

  • payload (Hash) —

    Request body of ‘confirmShipment`.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

Returns:



277
278
279
280
281
 
# File 'lib/peddler/apis/orders_v0.rb', line 277

def confirm_shipment(order_id, payload, rate_limit: 2.0)
  path = "/orders/v0/orders/#{percent_encode(order_id)}/shipmentConfirmation"
  body = payload
  meter(rate_limit).post(path, body:)
end

#get_order(order_id, rate_limit: 0.5) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns the order that you specify.

Parameters:

  • order_id (String) —

    An Amazon-defined order identifier, in 3-7-7 format.

  • rate_limit (Float) (defaults to: 0.5) —

    Requests per second

Returns:



162
163
164
165
166
 
# File 'lib/peddler/apis/orders_v0.rb', line 162

def get_order(order_id, rate_limit: 0.5)
  path = "/orders/v0/orders/#{percent_encode(order_id)}"
  parser = Peddler::Types::OrdersV0::GetOrderResponse if typed?
  meter(rate_limit).get(path, parser:)
end

#get_order_address(order_id, rate_limit: 0.5) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns the shipping address for the order that you specify.

Parameters:

  • order_id (String) —

    The Amazon order identifier in 3-7-7 format.

  • rate_limit (Float) (defaults to: 0.5) —

    Requests per second

Returns:



186
187
188
189
190
 
# File 'lib/peddler/apis/orders_v0.rb', line 186

def get_order_address(order_id, rate_limit: 0.5)
  path = "/orders/v0/orders/#{percent_encode(order_id)}/address"
  parser = Peddler::Types::OrdersV0::GetOrderAddressResponse if typed?
  meter(rate_limit).get(path, parser:)
end

#get_order_buyer_info(order_id, rate_limit: 0.5) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns buyer information for the order that you specify.

Parameters:

  • order_id (String) —

    The Amazon order identifier in 3-7-7 format.

  • rate_limit (Float) (defaults to: 0.5) —

    Requests per second

Returns:



174
175
176
177
178
 
# File 'lib/peddler/apis/orders_v0.rb', line 174

def get_order_buyer_info(order_id, rate_limit: 0.5)
  path = "/orders/v0/orders/#{percent_encode(order_id)}/buyerInfo"
  parser = Peddler::Types::OrdersV0::GetOrderBuyerInfoResponse if typed?
  meter(rate_limit).get(path, parser:)
end

#get_order_items(order_id, next_token: nil, rate_limit: 0.5) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

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.

Parameters:

  • order_id (String) —

    An Amazon-defined order identifier, in 3-7-7 format.

  • next_token (String) (defaults to: nil) —

    A string token returned in the response of your previous request.

  • rate_limit (Float) (defaults to: 0.5) —

    Requests per second

Returns:



207
208
209
210
211
212
213
214
 
# File 'lib/peddler/apis/orders_v0.rb', line 207

def get_order_items(order_id, next_token: nil, rate_limit: 0.5)
  path = "/orders/v0/orders/#{percent_encode(order_id)}/orderItems"
  params = {
    "NextToken" => next_token,
  }.compact
  parser = Peddler::Types::OrdersV0::GetOrderItemsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#get_order_items_buyer_info(order_id, next_token: nil, rate_limit: 0.5) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns buyer information for the order items in the order that you specify.

Parameters:

  • order_id (String) —

    An Amazon-defined order identifier, in 3-7-7 format.

  • next_token (String) (defaults to: nil) —

    A string token returned in the response of your previous request.

  • rate_limit (Float) (defaults to: 0.5) —

    Requests per second

Returns:



223
224
225
226
227
228
229
230
 
# File 'lib/peddler/apis/orders_v0.rb', line 223

def get_order_items_buyer_info(order_id, next_token: nil, rate_limit: 0.5)
  path = "/orders/v0/orders/#{percent_encode(order_id)}/orderItems/buyerInfo"
  params = {
    "NextToken" => next_token,
  }.compact
  parser = Peddler::Types::OrdersV0::GetOrderItemsBuyerInfoResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#get_order_regulated_info(order_id, rate_limit: 0.5) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns regulated information for the order that you specify.

Parameters:

  • order_id (String) —

    The Amazon order identifier in 3-7-7 format.

  • rate_limit (Float) (defaults to: 0.5) —

    Requests per second

Returns:



251
252
253
254
255
 
# File 'lib/peddler/apis/orders_v0.rb', line 251

def get_order_regulated_info(order_id, rate_limit: 0.5)
  path = "/orders/v0/orders/#{percent_encode(order_id)}/regulatedInfo"
  parser = Peddler::Types::OrdersV0::GetOrderRegulatedInfoResponse if typed?
  meter(rate_limit).get(path, parser:)
end

#get_orders(marketplace_ids, created_after: nil, created_before: nil, last_updated_after: nil, last_updated_before: nil, order_statuses: nil, fulfillment_channels: nil, payment_methods: nil, buyer_email: nil, seller_order_id: nil, max_results_per_page: nil, easy_ship_shipment_statuses: nil, electronic_invoice_statuses: nil, next_token: nil, amazon_order_ids: nil, actual_fulfillment_supply_source_id: nil, is_ispu: nil, store_chain_store_id: nil, earliest_delivery_date_before: nil, earliest_delivery_date_after: nil, latest_delivery_date_before: nil, latest_delivery_date_after: nil, rate_limit: 0.0167) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

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.

Parameters:

  • created_after (String) (defaults to: nil) —

    Use this date to select orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in [ISO 8601](developer-docs.amazon.com/sp-api/docs/iso-8601) format. Note: Either the ‘CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `LastUpdatedAfter` and `LastUpdatedBefore` cannot be set when `CreatedAfter` is set.

  • created_before (String) (defaults to: nil) —

    Use this date to select orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in [ISO 8601](developer-docs.amazon.com/sp-api/docs/iso-8601) format. Note: ‘CreatedBefore` is optional when `CreatedAfter` is set. If specified, `CreatedBefore` must be equal to or after the `CreatedAfter` date and at least two minutes before current time.

  • last_updated_after (String) (defaults to: nil) —

    Use this date to select orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](developer-docs.amazon.com/sp-api/docs/iso-8601) format. Note: Either the ‘CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `CreatedAfter` or `CreatedBefore` cannot be set when `LastUpdatedAfter` is set.

  • last_updated_before (String) (defaults to: nil) —

    Use this date to select orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](developer-docs.amazon.com/sp-api/docs/iso-8601) format. Note: ‘LastUpdatedBefore` is optional when `LastUpdatedAfter` is set. But if specified, `LastUpdatedBefore` must be equal to or after the `LastUpdatedAfter` date and at least two minutes before current time.

  • order_statuses (Array<String>) (defaults to: nil) —

    A list of ‘OrderStatus` values used to filter the results. **Possible values:** - `PendingAvailability` (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.) - `Pending` (The order has been placed but payment has not been authorized.) - `Unshipped` (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped.) - `PartiallyShipped` (One or more, but not all, items in the order have been shipped.) - `Shipped` (All items in the order have been shipped.) - `InvoiceUnconfirmed` (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.) - `Canceled` (The order has been canceled.) - `Unfulfillable` (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.)

  • marketplace_ids (Array<String>) —

    A list of ‘MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values.

  • fulfillment_channels (Array<String>) (defaults to: nil) —

    A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. **Possible values**: ‘AFN` (fulfilled by Amazon), `MFN` (fulfilled by seller).

  • payment_methods (Array<String>) (defaults to: nil) —

    A list of payment method values. Use this field to select orders that were paid with the specified payment methods. **Possible values**: ‘COD` (cash on delivery), `CVS` (convenience store), `Other` (Any payment method other than COD or CVS).

  • buyer_email (String) (defaults to: nil) —

    The email address of a buyer. Used to select orders that contain the specified email address.

  • seller_order_id (String) (defaults to: nil) —

    An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If ‘SellerOrderId` is specified, then `FulfillmentChannels`, `OrderStatuses`, `PaymentMethod`, `LastUpdatedAfter`, LastUpdatedBefore, and `BuyerEmail` cannot be specified.

  • max_results_per_page (Integer) (defaults to: nil) —

    A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.

  • easy_ship_shipment_statuses (Array<String>) (defaults to: nil) —

    A list of ‘EasyShipShipmentStatus` values. Used to select Easy Ship orders with statuses that match the specified values. If `EasyShipShipmentStatus` is specified, only Amazon Easy Ship orders are returned. **Possible values:** - `PendingSchedule` (The package is awaiting the schedule for pick-up.) - `PendingPickUp` (Amazon has not yet picked up the package from the seller.) - `PendingDropOff` (The seller will deliver the package to the carrier.) - `LabelCanceled` (The seller canceled the pickup.) - `PickedUp` (Amazon has picked up the package from the seller.) - `DroppedOff` (The package is delivered to the carrier by the seller.) - `AtOriginFC` (The packaged is at the origin fulfillment center.) - `AtDestinationFC` (The package is at the destination fulfillment center.) - `Delivered` (The package has been delivered.) - `RejectedByBuyer` (The package has been rejected by the buyer.) - `Undeliverable` (The package cannot be delivered.) - `ReturningToSeller` (The package was not delivered and is being returned to the seller.) - `ReturnedToSeller` (The package was not delivered and was returned to the seller.) - `Lost` (The package is lost.) - `OutForDelivery` (The package is out for delivery.) - `Damaged` (The package was damaged by the carrier.)

  • electronic_invoice_statuses (Array<String>) (defaults to: nil) —

    A list of ‘ElectronicInvoiceStatus` values. Used to select orders with electronic invoice statuses that match the specified values. **Possible values:** - `NotRequired` (Electronic invoice submission is not required for this order.) - `NotFound` (The electronic invoice was not submitted for this order.) - `Processing` (The electronic invoice is being processed for this order.) - `Errored` (The last submitted electronic invoice was rejected for this order.) - `Accepted` (The last submitted electronic invoice was submitted and accepted.)

  • next_token (String) (defaults to: nil) —

    A string token returned in the response of your previous request.

  • amazon_order_ids (Array<String>) (defaults to: nil) —

    A list of ‘AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format.

  • actual_fulfillment_supply_source_id (String) (defaults to: nil) —

    The ‘sourceId` of the location from where you want the order fulfilled.

  • is_ispu (Boolean) (defaults to: nil) —

    When true, this order is marked to be picked up from a store rather than delivered.

  • store_chain_store_id (String) (defaults to: nil) —

    The store chain store identifier. Linked to a specific store in a store chain.

  • earliest_delivery_date_before (String) (defaults to: nil) —

    Use this date to select orders with a earliest delivery date before (or at) a specified time. The date must be in [ISO 8601](developer-docs.amazon.com/sp-api/docs/iso-8601) format.

  • earliest_delivery_date_after (String) (defaults to: nil) —

    Use this date to select orders with a earliest delivery date after (or at) a specified time. The date must be in [ISO 8601](developer-docs.amazon.com/sp-api/docs/iso-8601) format.

  • latest_delivery_date_before (String) (defaults to: nil) —

    Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in [ISO 8601](developer-docs.amazon.com/sp-api/docs/iso-8601) format.

  • latest_delivery_date_after (String) (defaults to: nil) —

    Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in [ISO 8601](developer-docs.amazon.com/sp-api/docs/iso-8601) format.

  • rate_limit (Float) (defaults to: 0.0167) —

    Requests per second

Returns:



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/peddler/apis/orders_v0.rb', line 120

def get_orders(marketplace_ids, created_after: nil, created_before: nil, last_updated_after: nil,
  last_updated_before: nil, order_statuses: nil, fulfillment_channels: nil, payment_methods: nil,
  buyer_email: nil, seller_order_id: nil, max_results_per_page: nil, easy_ship_shipment_statuses: nil,
  electronic_invoice_statuses: nil, next_token: nil, amazon_order_ids: nil,
  actual_fulfillment_supply_source_id: nil, is_ispu: nil, store_chain_store_id: nil,
  earliest_delivery_date_before: nil, earliest_delivery_date_after: nil, latest_delivery_date_before: nil,
  latest_delivery_date_after: nil, rate_limit: 0.0167)
  path = "/orders/v0/orders"
  params = {
    "CreatedAfter" => created_after,
    "CreatedBefore" => created_before,
    "LastUpdatedAfter" => last_updated_after,
    "LastUpdatedBefore" => last_updated_before,
    "OrderStatuses" => stringify_array(order_statuses),
    "MarketplaceIds" => stringify_array(marketplace_ids),
    "FulfillmentChannels" => stringify_array(fulfillment_channels),
    "PaymentMethods" => stringify_array(payment_methods),
    "BuyerEmail" => buyer_email,
    "SellerOrderId" => seller_order_id,
    "MaxResultsPerPage" => max_results_per_page,
    "EasyShipShipmentStatuses" => stringify_array(easy_ship_shipment_statuses),
    "ElectronicInvoiceStatuses" => stringify_array(electronic_invoice_statuses),
    "NextToken" => next_token,
    "AmazonOrderIds" => stringify_array(amazon_order_ids),
    "ActualFulfillmentSupplySourceId" => actual_fulfillment_supply_source_id,
    "IsISPU" => is_ispu,
    "StoreChainStoreId" => store_chain_store_id,
    "EarliestDeliveryDateBefore" => earliest_delivery_date_before,
    "EarliestDeliveryDateAfter" => earliest_delivery_date_after,
    "LatestDeliveryDateBefore" => latest_delivery_date_before,
    "LatestDeliveryDateAfter" => latest_delivery_date_after,
  }.compact
  parser = Peddler::Types::OrdersV0::GetOrdersResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#update_shipment_status(order_id, payload, rate_limit: 5.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Update the shipment status for an order that you specify.

Parameters:

  • order_id (String) —

    An Amazon-defined order identifier, in 3-7-7 format.

  • payload (Hash) —

    The request body for the ‘updateShipmentStatus` operation.

  • rate_limit (Float) (defaults to: 5.0) —

    Requests per second

Returns:



239
240
241
242
243
 
# File 'lib/peddler/apis/orders_v0.rb', line 239

def update_shipment_status(order_id, payload, rate_limit: 5.0)
  path = "/orders/v0/orders/#{percent_encode(order_id)}/shipment"
  body = payload
  meter(rate_limit).post(path, body:)
end

#update_verification_status(order_id, payload, rate_limit: 0.5) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Updates (approves or rejects) the verification status of an order containing regulated products.

Parameters:

  • order_id (String) —

    The Amazon order identifier in 3-7-7 format.

  • payload (Hash) —

    The request body for the ‘updateVerificationStatus` operation.

  • rate_limit (Float) (defaults to: 0.5) —

    Requests per second

Returns:



264
265
266
267
268
 
# File 'lib/peddler/apis/orders_v0.rb', line 264

def update_verification_status(order_id, payload, rate_limit: 0.5)
  path = "/orders/v0/orders/#{percent_encode(order_id)}/regulatedInfo"
  body = payload
  meter(rate_limit).patch(path, body:)
end