Class: WalmartApIs::StrategiesApi

Inherits:
BaseApi
  • Object
show all
Defined in:
lib/walmart_ap_is/apis/strategies_api.rb

Overview

StrategiesApi

Constant Summary

Constants inherited from BaseApi

BaseApi::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseApi

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseApi

#initialize, #new_parameter, #new_request_builder, #new_response_handler, user_agent, user_agent_parameters

Constructor Details

This class inherits a constructor from WalmartApIs::BaseApi

Instance Method Details

#retrieve_repricer_strategy_details(wm_sec_access_token, wm_consumer_channel_type, wm_qos_correlation_id, wm_svc_name, accept) ⇒ ApiResponse

Retrieves the details of a specific repricer strategy that was previously created for items in Walmart Marketplace.

Use this API to view the list of strategies used and details about the

strategy including the strategy collection name, status, assigned items count, and strategy type. For more information and usage examples, refer to the <a href=“developer.walmart.com/us-marketplace/docs/get-repricer-strat egy”>Pricing API Guide</a>. obtained from the Token API. This is required for authenticating requests to Walmart Marketplace APIs. to track the consumer request by channel. Use the Consumer Channel Type received during onboarding. identifies each API call and is used to track and debug issues. Use a randomly generated GUID for this ID. Walmart service being called.

Parameters:

  • wm_sec_access_token (String) —

    Required parameter: Access token

  • wm_consumer_channel_type (String) —

    Required parameter: A unique ID

  • wm_qos_correlation_id (String) —

    Required parameter: A unique ID that

  • wm_svc_name (String) —

    Required parameter: Specifies the name of the

  • accept (String) —

    Required parameter: TODO: type description here

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/walmart_ap_is/apis/strategies_api.rb', line 30

def retrieve_repricer_strategy_details(wm_sec_access_token,
                                       wm_consumer_channel_type,
                                       wm_qos_correlation_id,
                                       wm_svc_name,
                                       accept)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/repricer/strategies',
                                 Server::SERVER_1)
               .header_param(new_parameter(wm_sec_access_token, key: 'WM_SEC.ACCESS_TOKEN')
                              .is_required(true))
               .header_param(new_parameter(wm_consumer_channel_type, key: 'WM_CONSUMER.CHANNEL.TYPE')
                              .is_required(true))
               .header_param(new_parameter(wm_qos_correlation_id, key: 'WM_QOS.CORRELATION_ID')
                              .is_required(true))
               .header_param(new_parameter(wm_svc_name, key: 'WM_SVC.NAME')
                              .is_required(true))
               .header_param(new_parameter(accept, key: 'Accept')
                              .is_required(true)))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SuccessfulOperation3.method(:from_hash))
                .is_api_response(true))
    .execute
end