Class: DeliveryFivePostClient::Resources::API::V2::Partners

Inherits:

Object

• Object
• DeliveryFivePostClient::Resources::API::V2::Partners

Defined in:

lib/delivery_five_post_client/resources/api/v2/partners.rb

Instance Method Summary

• #create_return_order(base_order:, cargoes:, return_location_id:, warehouse:, request_options: {}) ⇒ DeliveryFivePostClient::Models::API::V2::PartnerCreateReturnOrderResponse

  Создание возвратного заказа.

• #initialize(client:) ⇒ Partners constructor private

  A new instance of Partners.

Constructor Details

#initialize(client:) ⇒ Partners

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Partners.

Parameters:

• client (DeliveryFivePostClient::Client)

# File 'lib/delivery_five_post_client/resources/api/v2/partners.rb', line 40

def initialize(client:)
  @client = client
end

Instance Method Details

#create_return_order(base_order:, cargoes:, return_location_id:, warehouse:, request_options: {}) ⇒ DeliveryFivePostClient::Models::API::V2::PartnerCreateReturnOrderResponse

Создание возвратного заказа. senderOrderId формируется как RT + barcode / Create return order. senderOrderId format: RT + barcode

Parameters:

• base_order (DeliveryFivePostClient::Models::API::V2::PartnerCreateReturnOrderParams::BaseOrder) —

  Базовый заказ для возврата / Base order for return

• cargoes (Array<DeliveryFivePostClient::Models::API::V1::Cargo>) —

  Грузоместа для возврата / Return cargoes

• return_location_id (String) —

  UUID в формате v4 / UUID in v4 format

• warehouse (DeliveryFivePostClient::Models::API::V2::PartnerCreateReturnOrderParams::Warehouse) —

  Склад возврата / Return warehouse

• request_options (DeliveryFivePostClient::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (DeliveryFivePostClient::Models::API::V2::PartnerCreateReturnOrderResponse)

See Also:

• Models::API::V2::PartnerCreateReturnOrderParams

# File 'lib/delivery_five_post_client/resources/api/v2/partners.rb', line 26

def create_return_order(params)
  parsed, options = DeliveryFivePostClient::API::V2::PartnerCreateReturnOrderParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/v2/partners/return",
    body: parsed,
    model: DeliveryFivePostClient::Models::API::V2::PartnerCreateReturnOrderResponse,
    options: options
  )
end