Class: InventoryManagementAndItemManagementAndOrderManagementAndPriceManagement::CancelController

Inherits:
BaseController
  • Object
show all
Defined in:
lib/inventory_management_and_item_management_and_order_management_and_price_management/controllers/cancel_controller.rb

Overview

CancelController

Constant Summary

Constants inherited from BaseController

BaseController::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseController

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseController

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

Constructor Details

This class inherits a constructor from InventoryManagementAndItemManagementAndOrderManagementAndPriceManagement::BaseController

Instance Method Details

#cancel_order_lines(purchase_order_id, wm_sec_access_token, wm_consumer_channel_type, wm_qos_correlation_id, wm_svc_name, accept, body) ⇒ SuccessfulOperation10

You can cancel one or more order lines. You must include a purchaseOrderId when cancelling an order line. The response to a successful call contains the order with the cancelled line items purchaseOrderId access token retrieved in the Token API call to track the consumer request by channel. Use the Consumer Channel Type received during onboarding unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID Name description here

Parameters:

  • purchase_order_id (String) —

    Required parameter: (Required)

  • wm_sec_access_token (String) —

    Required parameter: (Required) The

  • wm_consumer_channel_type (String) —

    Required parameter: A unique ID

  • wm_qos_correlation_id (String) —

    Required parameter: (Required) A

  • wm_svc_name (String) —

    Required parameter: (Required) Walmart Service

  • accept (String) —

    Required parameter: TODO: type description here

  • body (CancelOrderLinesRequest) —

    Required parameter: TODO: type

Returns:



29
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/inventory_management_and_item_management_and_order_management_and_price_management/controllers/cancel_controller.rb', line 29

def cancel_order_lines(purchase_order_id,
                       wm_sec_access_token,
                       wm_consumer_channel_type,
                       wm_qos_correlation_id,
                       wm_svc_name,
                       accept,
                       body)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/orders/{purchaseOrderId}/cancel',
                                 Server::DEFAULT)
               .template_param(new_parameter(purchase_order_id, key: 'purchaseOrderId')
                                .should_encode(true))
               .header_param(new_parameter(wm_sec_access_token, key: 'WM_SEC.ACCESS_TOKEN'))
               .header_param(new_parameter(wm_consumer_channel_type, key: 'WM_CONSUMER.CHANNEL.TYPE'))
               .header_param(new_parameter(wm_qos_correlation_id, key: 'WM_QOS.CORRELATION_ID'))
               .header_param(new_parameter(wm_svc_name, key: 'WM_SVC.NAME'))
               .header_param(new_parameter(accept, key: 'Accept'))
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body))
               .body_serializer(proc do |param| param.to_json unless param.nil? end))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(SuccessfulOperation10.method(:from_hash)))
    .execute
end