Class: Peddler::API::ApplicationIntegrations20240401

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

Overview

The Selling Partner API for third party application integrations.

With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.

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

#create_notification(body, rate_limit: 1.0) ⇒ Hash

Note:

This operation can make a static sandbox call.

Create a notification for sellers in Seller Central.

Parameters:

  • body (Hash) —

    The request body for the ‘createNotification` operation.

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

    Requests per second

Returns:

  • (Hash) —

    The API response



24
25
26
27
28
 
# File 'lib/peddler/api/application_integrations_2024_04_01.rb', line 24

def create_notification(body, rate_limit: 1.0)
  path = "/appIntegrations/2024-04-01/notifications"

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

#delete_notifications(body, rate_limit: 1.0) ⇒ Hash

Note:

This operation can make a static sandbox call.

Remove your application’s notifications from the Appstore notifications dashboard.

Parameters:

  • body (Hash) —

    The request body for the ‘deleteNotifications` operation.

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

    Requests per second

Returns:

  • (Hash) —

    The API response



36
37
38
39
40
 
# File 'lib/peddler/api/application_integrations_2024_04_01.rb', line 36

def delete_notifications(body, rate_limit: 1.0)
  path = "/appIntegrations/2024-04-01/notifications/deletion"

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

#record_action_feedback(notification_id, body, rate_limit: 1.0) ⇒ Hash

Note:

This operation can make a static sandbox call.

Records the seller’s response to a notification.

Parameters:

  • notification_id (String) —

    A ‘notificationId` uniquely identifies a notification.

  • body (Hash) —

    The request body for the ‘recordActionFeedback` operation.

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

    Requests per second

Returns:

  • (Hash) —

    The API response



49
50
51
52
53
 
# File 'lib/peddler/api/application_integrations_2024_04_01.rb', line 49

def record_action_feedback(notification_id, body, rate_limit: 1.0)
  path = "/appIntegrations/2024-04-01/notifications/#{notification_id}/feedback"

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