wine_shipping 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/README.md +128 -0
- data/Rakefile +8 -0
- data/docs/Authentication.md +10 -0
- data/docs/BillingContactInfo.md +18 -0
- data/docs/DeliveryContactInfo.md +17 -0
- data/docs/Inventory.md +20 -0
- data/docs/InventoryApi.md +102 -0
- data/docs/InventoryMovementApi.md +100 -0
- data/docs/InventoryStatusRequest.md +13 -0
- data/docs/InventoryStatusResult.md +12 -0
- data/docs/ItemInfo.md +10 -0
- data/docs/OrderOnHold.md +19 -0
- data/docs/OrderOnHoldItem.md +11 -0
- data/docs/PackageItem.md +10 -0
- data/docs/PurchaseOrderDetails.md +10 -0
- data/docs/PurchaseOrderInfo.md +24 -0
- data/docs/PurchaseOrderItemInfo.md +10 -0
- data/docs/RecipientContactInfo.md +18 -0
- data/docs/RequestorInfo.md +11 -0
- data/docs/ReturnResult.md +12 -0
- data/docs/ReturnSalesOrderHeader.md +31 -0
- data/docs/ReturnSalesOrderLine.md +13 -0
- data/docs/ReturnsRequest.md +16 -0
- data/docs/SKUApi.md +54 -0
- data/docs/SKUDetails.md +10 -0
- data/docs/SKUInfo.md +20 -0
- data/docs/SalesOrderApi.md +240 -0
- data/docs/SalesOrderCancelRequest.md +9 -0
- data/docs/SalesOrderDetails.md +14 -0
- data/docs/SalesOrderInfo.md +20 -0
- data/docs/ShipmentInfo.md +13 -0
- data/docs/TrackingApi.md +55 -0
- data/docs/TrackingRequest.md +9 -0
- data/docs/TrackingResult.md +28 -0
- data/docs/TransferOrderDetails.md +10 -0
- data/docs/TransferOrderInfo.md +17 -0
- data/docs/TransferOrderItemInfo.md +10 -0
- data/docs/WarehouseInventoryStatus.md +19 -0
- data/git_push.sh +55 -0
- data/lib/.DS_Store +0 -0
- data/lib/wine_shipping.rb +75 -0
- data/lib/wine_shipping/api/inventory_api.rb +127 -0
- data/lib/wine_shipping/api/inventory_movement_api.rb +125 -0
- data/lib/wine_shipping/api/sales_order_api.rb +280 -0
- data/lib/wine_shipping/api/sku_api.rb +74 -0
- data/lib/wine_shipping/api/tracking_api.rb +75 -0
- data/lib/wine_shipping/api_client.rb +388 -0
- data/lib/wine_shipping/api_error.rb +38 -0
- data/lib/wine_shipping/configuration.rb +202 -0
- data/lib/wine_shipping/models/authentication.rb +201 -0
- data/lib/wine_shipping/models/billing_contact_info.rb +273 -0
- data/lib/wine_shipping/models/delivery_contact_info.rb +298 -0
- data/lib/wine_shipping/models/inventory.rb +291 -0
- data/lib/wine_shipping/models/inventory_status_request.rb +230 -0
- data/lib/wine_shipping/models/inventory_status_result.rb +221 -0
- data/lib/wine_shipping/models/item_info.rb +201 -0
- data/lib/wine_shipping/models/order_on_hold.rb +284 -0
- data/lib/wine_shipping/models/order_on_hold_item.rb +210 -0
- data/lib/wine_shipping/models/package_item.rb +201 -0
- data/lib/wine_shipping/models/purchase_order_details.rb +203 -0
- data/lib/wine_shipping/models/purchase_order_info.rb +361 -0
- data/lib/wine_shipping/models/purchase_order_item_info.rb +201 -0
- data/lib/wine_shipping/models/recipient_contact_info.rb +273 -0
- data/lib/wine_shipping/models/requestor_info.rb +210 -0
- data/lib/wine_shipping/models/return_result.rb +221 -0
- data/lib/wine_shipping/models/return_sales_order_header.rb +392 -0
- data/lib/wine_shipping/models/return_sales_order_line.rb +228 -0
- data/lib/wine_shipping/models/returns_request.rb +257 -0
- data/lib/wine_shipping/models/sales_order_cancel_request.rb +192 -0
- data/lib/wine_shipping/models/sales_order_details.rb +239 -0
- data/lib/wine_shipping/models/sales_order_info.rb +325 -0
- data/lib/wine_shipping/models/shipment_info.rb +274 -0
- data/lib/wine_shipping/models/sku_details.rb +201 -0
- data/lib/wine_shipping/models/sku_info.rb +325 -0
- data/lib/wine_shipping/models/tracking_request.rb +192 -0
- data/lib/wine_shipping/models/tracking_result.rb +365 -0
- data/lib/wine_shipping/models/transfer_order_details.rb +203 -0
- data/lib/wine_shipping/models/transfer_order_info.rb +264 -0
- data/lib/wine_shipping/models/transfer_order_item_info.rb +201 -0
- data/lib/wine_shipping/models/warehouse_inventory_status.rb +282 -0
- data/lib/wine_shipping/version.rb +15 -0
- data/spec/api/inventory_api_spec.rb +57 -0
- data/spec/api/inventory_movement_api_spec.rb +57 -0
- data/spec/api/sales_order_api_spec.rb +90 -0
- data/spec/api/sku_api_spec.rb +46 -0
- data/spec/api/tracking_api_spec.rb +46 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/authentication_spec.rb +53 -0
- data/spec/models/billing_contact_info_spec.rb +101 -0
- data/spec/models/delivery_contact_info_spec.rb +99 -0
- data/spec/models/inventory_spec.rb +113 -0
- data/spec/models/inventory_status_request_spec.rb +71 -0
- data/spec/models/inventory_status_result_spec.rb +65 -0
- data/spec/models/item_info_spec.rb +53 -0
- data/spec/models/order_on_hold_item_spec.rb +59 -0
- data/spec/models/order_on_hold_spec.rb +107 -0
- data/spec/models/package_item_spec.rb +53 -0
- data/spec/models/purchase_order_details_spec.rb +53 -0
- data/spec/models/purchase_order_info_spec.rb +141 -0
- data/spec/models/purchase_order_item_info_spec.rb +53 -0
- data/spec/models/recipient_contact_info_spec.rb +101 -0
- data/spec/models/requestor_info_spec.rb +59 -0
- data/spec/models/return_result_spec.rb +65 -0
- data/spec/models/return_sales_order_header_spec.rb +179 -0
- data/spec/models/return_sales_order_line_spec.rb +71 -0
- data/spec/models/returns_request_spec.rb +89 -0
- data/spec/models/sales_order_cancel_request_spec.rb +47 -0
- data/spec/models/sales_order_details_spec.rb +77 -0
- data/spec/models/sales_order_info_spec.rb +117 -0
- data/spec/models/shipment_info_spec.rb +79 -0
- data/spec/models/sku_details_spec.rb +53 -0
- data/spec/models/sku_info_spec.rb +117 -0
- data/spec/models/tracking_request_spec.rb +47 -0
- data/spec/models/tracking_result_spec.rb +161 -0
- data/spec/models/transfer_order_details_spec.rb +53 -0
- data/spec/models/transfer_order_info_spec.rb +95 -0
- data/spec/models/transfer_order_item_info_spec.rb +53 -0
- data/spec/models/warehouse_inventory_status_spec.rb +107 -0
- data/spec/spec_helper.rb +111 -0
- data/wine_shipping.gemspec +45 -0
- metadata +390 -0
data/docs/ItemInfo.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# WineShipping::ItemInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**item_no** | **String** | | [optional]
|
7
|
+
**item_description** | **String** | | [optional]
|
8
|
+
**item_quantity** | **Integer** | | [optional]
|
9
|
+
|
10
|
+
|
data/docs/OrderOnHold.md
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
# WineShipping::OrderOnHold
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**customer_no** | **String** | | [optional]
|
7
|
+
**customer_name** | **String** | | [optional]
|
8
|
+
**order_no** | **String** | | [optional]
|
9
|
+
**order_type** | **String** | | [optional]
|
10
|
+
**order_date** | **String** | | [optional]
|
11
|
+
**shipment_date** | **String** | | [optional]
|
12
|
+
**shipping_site** | **String** | | [optional]
|
13
|
+
**shipping_warehouse** | **String** | | [optional]
|
14
|
+
**hold_reason** | **String** | | [optional]
|
15
|
+
**shipping_carrier** | **String** | | [optional]
|
16
|
+
**shipping_carrier_service** | **String** | | [optional]
|
17
|
+
**order_on_hold_items** | [**Array<OrderOnHoldItem>**](OrderOnHoldItem.md) | | [optional]
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# WineShipping::OrderOnHoldItem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**item_no** | **String** | | [optional]
|
7
|
+
**quantity** | **String** | | [optional]
|
8
|
+
**item_description** | **String** | | [optional]
|
9
|
+
**quantity_reserved** | **String** | | [optional]
|
10
|
+
|
11
|
+
|
data/docs/PackageItem.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# WineShipping::PackageItem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**item_no** | **String** | | [optional]
|
7
|
+
**quantity** | **String** | | [optional]
|
8
|
+
**item_description** | **String** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# WineShipping::PurchaseOrderDetails
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**authentication** | [**Authentication**](Authentication.md) | | [optional]
|
7
|
+
**order_info** | [**PurchaseOrderInfo**](PurchaseOrderInfo.md) | | [optional]
|
8
|
+
**items_info** | [**Array<PurchaseOrderItemInfo>**](PurchaseOrderItemInfo.md) | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# WineShipping::PurchaseOrderInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**customer_reference_no** | **String** | | [optional]
|
7
|
+
**transport_method** | **Integer** | | [optional]
|
8
|
+
**requested_date** | **DateTime** | | [optional]
|
9
|
+
**receive_to_location** | **String** | | [optional]
|
10
|
+
**inventory_status_code** | **String** | | [optional]
|
11
|
+
**reference_no** | **String** | | [optional]
|
12
|
+
**first_name** | **String** | | [optional]
|
13
|
+
**last_name** | **String** | | [optional]
|
14
|
+
**company** | **String** | | [optional]
|
15
|
+
**address** | **String** | | [optional]
|
16
|
+
**address2** | **String** | | [optional]
|
17
|
+
**city** | **String** | | [optional]
|
18
|
+
**state** | **String** | | [optional]
|
19
|
+
**zip_code** | **String** | | [optional]
|
20
|
+
**phone_number** | **String** | | [optional]
|
21
|
+
**email_address** | **String** | | [optional]
|
22
|
+
**special_instruction** | **String** | | [optional]
|
23
|
+
|
24
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# WineShipping::PurchaseOrderItemInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**item_no** | **String** | | [optional]
|
7
|
+
**item_description** | **String** | | [optional]
|
8
|
+
**item_quantity** | **Integer** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# WineShipping::RecipientContactInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**first_name** | **String** | | [optional]
|
7
|
+
**last_name** | **String** | | [optional]
|
8
|
+
**company** | **String** | | [optional]
|
9
|
+
**address** | **String** | | [optional]
|
10
|
+
**address2** | **String** | | [optional]
|
11
|
+
**city** | **String** | | [optional]
|
12
|
+
**state** | **String** | | [optional]
|
13
|
+
**zip_code** | **String** | | [optional]
|
14
|
+
**country** | **String** | | [optional]
|
15
|
+
**phone_number** | **String** | | [optional]
|
16
|
+
**email_address** | **String** | | [optional]
|
17
|
+
|
18
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# WineShipping::RequestorInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**first_name** | **String** | | [optional]
|
7
|
+
**last_name** | **String** | | [optional]
|
8
|
+
**phone_number** | **String** | | [optional]
|
9
|
+
**email_address** | **String** | | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# WineShipping::ReturnResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**total_record_count** | **Integer** | | [optional]
|
7
|
+
**skip** | **Integer** | | [optional]
|
8
|
+
**top** | **Integer** | | [optional]
|
9
|
+
**more_records** | **BOOLEAN** | | [optional]
|
10
|
+
**return_sales_order_headers** | [**Array<ReturnSalesOrderHeader>**](ReturnSalesOrderHeader.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# WineShipping::ReturnSalesOrderHeader
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**customer_no** | **String** | | [optional]
|
7
|
+
**customer_name** | **String** | | [optional]
|
8
|
+
**rma_number** | **String** | | [optional]
|
9
|
+
**order_no** | **String** | | [optional]
|
10
|
+
**received_date** | **String** | | [optional]
|
11
|
+
**close_date** | **String** | | [optional]
|
12
|
+
**ship_to_name** | **String** | | [optional]
|
13
|
+
**ship_to_company** | **String** | | [optional]
|
14
|
+
**ship_to_address** | **String** | | [optional]
|
15
|
+
**ship_to_address2** | **String** | | [optional]
|
16
|
+
**ship_to_city** | **String** | | [optional]
|
17
|
+
**ship_to_state** | **String** | | [optional]
|
18
|
+
**ship_to_zip_code** | **String** | | [optional]
|
19
|
+
**ship_to_country** | **String** | | [optional]
|
20
|
+
**email_address** | **String** | | [optional]
|
21
|
+
**phone_number** | **String** | | [optional]
|
22
|
+
**return_warehouse** | **String** | | [optional]
|
23
|
+
**return_status** | **String** | | [optional]
|
24
|
+
**disposition_code** | **String** | | [optional]
|
25
|
+
**return_reason** | **String** | | [optional]
|
26
|
+
**original_tracking_number** | **String** | | [optional]
|
27
|
+
**shipping_carrier_code** | **String** | | [optional]
|
28
|
+
**shippng_service_code** | **String** | | [optional]
|
29
|
+
**return_sales_order_lines** | [**Array<ReturnSalesOrderLine>**](ReturnSalesOrderLine.md) | | [optional]
|
30
|
+
|
31
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# WineShipping::ReturnSalesOrderLine
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**item_no** | **String** | | [optional]
|
7
|
+
**item_description** | **String** | | [optional]
|
8
|
+
**quantity** | **String** | | [optional]
|
9
|
+
**uom** | **String** | | [optional]
|
10
|
+
**disposition_code** | **String** | | [optional]
|
11
|
+
**inventory_status_code** | **String** | | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# WineShipping::ReturnsRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**authentication** | [**Authentication**](Authentication.md) | | [optional]
|
7
|
+
**order_numbers** | **Array<String>** | | [optional]
|
8
|
+
**start_time** | **DateTime** | | [optional]
|
9
|
+
**end_time** | **DateTime** | | [optional]
|
10
|
+
**disposition_code** | **String** | | [optional]
|
11
|
+
**warehouse** | **String** | | [optional]
|
12
|
+
**include_total_record_count** | **BOOLEAN** | | [optional]
|
13
|
+
**skip** | **Integer** | | [optional]
|
14
|
+
**top** | **Integer** | | [optional]
|
15
|
+
|
16
|
+
|
data/docs/SKUApi.md
ADDED
@@ -0,0 +1,54 @@
|
|
1
|
+
# WineShipping::SKUApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://wsservices-test.azurewebsites.net*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create_sku**](SKUApi.md#create_sku) | **POST** /api/SKU/CreateSKU |
|
8
|
+
|
9
|
+
|
10
|
+
# **create_sku**
|
11
|
+
> create_sku(sku_request_details)
|
12
|
+
|
13
|
+
|
14
|
+
|
15
|
+
Successful execution of this method will generate a new SKU in Wineshipping's system and will return a transaction reference identifier. Store this identifier back into your system for reference later in the event there is an issue with the SKU.
|
16
|
+
|
17
|
+
### Example
|
18
|
+
```ruby
|
19
|
+
# load the gem
|
20
|
+
require 'wine_shipping'
|
21
|
+
|
22
|
+
api_instance = WineShipping::SKUApi.new
|
23
|
+
|
24
|
+
sku_request_details = WineShipping::SKUDetails.new # SKUDetails |
|
25
|
+
|
26
|
+
|
27
|
+
begin
|
28
|
+
api_instance.create_sku(sku_request_details)
|
29
|
+
rescue WineShipping::ApiError => e
|
30
|
+
puts "Exception when calling SKUApi->create_sku: #{e}"
|
31
|
+
end
|
32
|
+
```
|
33
|
+
|
34
|
+
### Parameters
|
35
|
+
|
36
|
+
Name | Type | Description | Notes
|
37
|
+
------------- | ------------- | ------------- | -------------
|
38
|
+
**sku_request_details** | [**SKUDetails**](SKUDetails.md)| |
|
39
|
+
|
40
|
+
### Return type
|
41
|
+
|
42
|
+
nil (empty response body)
|
43
|
+
|
44
|
+
### Authorization
|
45
|
+
|
46
|
+
No authorization required
|
47
|
+
|
48
|
+
### HTTP request headers
|
49
|
+
|
50
|
+
- **Content-Type**: application/json
|
51
|
+
- **Accept**: application/json
|
52
|
+
|
53
|
+
|
54
|
+
|
data/docs/SKUDetails.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# WineShipping::SKUDetails
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**authentication** | [**Authentication**](Authentication.md) | | [optional]
|
7
|
+
**requestor_info** | [**RequestorInfo**](RequestorInfo.md) | | [optional]
|
8
|
+
**sku_info** | [**SKUInfo**](SKUInfo.md) | | [optional]
|
9
|
+
|
10
|
+
|
data/docs/SKUInfo.md
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
# WineShipping::SKUInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**item_category** | **Integer** | | [optional]
|
7
|
+
**item_no** | **String** | | [optional]
|
8
|
+
**item_description** | **String** | | [optional]
|
9
|
+
**vintage** | **String** | | [optional]
|
10
|
+
**varietal** | **String** | | [optional]
|
11
|
+
**appellation** | **String** | | [optional]
|
12
|
+
**value** | **String** | | [optional]
|
13
|
+
**alcohol_by_volume** | **String** | | [optional]
|
14
|
+
**upc_code** | **String** | | [optional]
|
15
|
+
**uom** | **String** | | [optional]
|
16
|
+
**num_bottle_in_each_case** | **String** | | [optional]
|
17
|
+
**classification** | **String** | | [optional]
|
18
|
+
**comments** | **String** | | [optional]
|
19
|
+
|
20
|
+
|
@@ -0,0 +1,240 @@
|
|
1
|
+
# WineShipping::SalesOrderApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://wsservices-test.azurewebsites.net*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**cancel_sales_order**](SalesOrderApi.md#cancel_sales_order) | **POST** /api/SalesOrder/CancelSalesOrder |
|
8
|
+
[**create_sales_order**](SalesOrderApi.md#create_sales_order) | **POST** /api/SalesOrder/CreateSalesOrder |
|
9
|
+
[**get_orders_on_hold**](SalesOrderApi.md#get_orders_on_hold) | **POST** /api/SalesOrder/GetOrdersOnHold |
|
10
|
+
[**get_returns**](SalesOrderApi.md#get_returns) | **POST** /api/SalesOrder/GetReturns |
|
11
|
+
[**replace_sales_order**](SalesOrderApi.md#replace_sales_order) | **POST** /api/SalesOrder/ReplaceSalesOrder |
|
12
|
+
|
13
|
+
|
14
|
+
# **cancel_sales_order**
|
15
|
+
> cancel_sales_order(cancel_sales_order_request)
|
16
|
+
|
17
|
+
|
18
|
+
|
19
|
+
Use this operation to cancel an existing open sales order. Successful execution of this method will cancel the sales order in Wineshipping system. If the order cannot be cancelled for some reason standard HTTP Status Code and a reason will be returned.
|
20
|
+
|
21
|
+
### Example
|
22
|
+
```ruby
|
23
|
+
# load the gem
|
24
|
+
require 'wine_shipping'
|
25
|
+
|
26
|
+
api_instance = WineShipping::SalesOrderApi.new
|
27
|
+
|
28
|
+
cancel_sales_order_request = WineShipping::SalesOrderCancelRequest.new # SalesOrderCancelRequest |
|
29
|
+
|
30
|
+
|
31
|
+
begin
|
32
|
+
api_instance.cancel_sales_order(cancel_sales_order_request)
|
33
|
+
rescue WineShipping::ApiError => e
|
34
|
+
puts "Exception when calling SalesOrderApi->cancel_sales_order: #{e}"
|
35
|
+
end
|
36
|
+
```
|
37
|
+
|
38
|
+
### Parameters
|
39
|
+
|
40
|
+
Name | Type | Description | Notes
|
41
|
+
------------- | ------------- | ------------- | -------------
|
42
|
+
**cancel_sales_order_request** | [**SalesOrderCancelRequest**](SalesOrderCancelRequest.md)| |
|
43
|
+
|
44
|
+
### Return type
|
45
|
+
|
46
|
+
nil (empty response body)
|
47
|
+
|
48
|
+
### Authorization
|
49
|
+
|
50
|
+
No authorization required
|
51
|
+
|
52
|
+
### HTTP request headers
|
53
|
+
|
54
|
+
- **Content-Type**: application/json
|
55
|
+
- **Accept**: application/json
|
56
|
+
|
57
|
+
|
58
|
+
|
59
|
+
# **create_sales_order**
|
60
|
+
> create_sales_order(order_details_info)
|
61
|
+
|
62
|
+
|
63
|
+
|
64
|
+
Successful execution of this method will generate a new shipment order in Wineshipping's system and will return a transaction reference identifier. Store this identifier back into your system for reference later in the event there is an issue with your order.
|
65
|
+
|
66
|
+
### Example
|
67
|
+
```ruby
|
68
|
+
# load the gem
|
69
|
+
require 'wine_shipping'
|
70
|
+
|
71
|
+
api_instance = WineShipping::SalesOrderApi.new
|
72
|
+
|
73
|
+
order_details_info = WineShipping::SalesOrderDetails.new # SalesOrderDetails |
|
74
|
+
|
75
|
+
|
76
|
+
begin
|
77
|
+
api_instance.create_sales_order(order_details_info)
|
78
|
+
rescue WineShipping::ApiError => e
|
79
|
+
puts "Exception when calling SalesOrderApi->create_sales_order: #{e}"
|
80
|
+
end
|
81
|
+
```
|
82
|
+
|
83
|
+
### Parameters
|
84
|
+
|
85
|
+
Name | Type | Description | Notes
|
86
|
+
------------- | ------------- | ------------- | -------------
|
87
|
+
**order_details_info** | [**SalesOrderDetails**](SalesOrderDetails.md)| |
|
88
|
+
|
89
|
+
### Return type
|
90
|
+
|
91
|
+
nil (empty response body)
|
92
|
+
|
93
|
+
### Authorization
|
94
|
+
|
95
|
+
No authorization required
|
96
|
+
|
97
|
+
### HTTP request headers
|
98
|
+
|
99
|
+
- **Content-Type**: application/json
|
100
|
+
- **Accept**: application/json
|
101
|
+
|
102
|
+
|
103
|
+
|
104
|
+
# **get_orders_on_hold**
|
105
|
+
> Array<OrderOnHold> get_orders_on_hold(authentication_details)
|
106
|
+
|
107
|
+
|
108
|
+
|
109
|
+
Use this operation to retrieve a list of on-hold orders for a customer. Successful execution of this method will generate a list of on hold orders from Wineshipping's system and if no orders are on hold, HTTP status code Not Found response will be returned.
|
110
|
+
|
111
|
+
### Example
|
112
|
+
```ruby
|
113
|
+
# load the gem
|
114
|
+
require 'wine_shipping'
|
115
|
+
|
116
|
+
api_instance = WineShipping::SalesOrderApi.new
|
117
|
+
|
118
|
+
authentication_details = WineShipping::Authentication.new # Authentication |
|
119
|
+
|
120
|
+
|
121
|
+
begin
|
122
|
+
result = api_instance.get_orders_on_hold(authentication_details)
|
123
|
+
p result
|
124
|
+
rescue WineShipping::ApiError => e
|
125
|
+
puts "Exception when calling SalesOrderApi->get_orders_on_hold: #{e}"
|
126
|
+
end
|
127
|
+
```
|
128
|
+
|
129
|
+
### Parameters
|
130
|
+
|
131
|
+
Name | Type | Description | Notes
|
132
|
+
------------- | ------------- | ------------- | -------------
|
133
|
+
**authentication_details** | [**Authentication**](Authentication.md)| |
|
134
|
+
|
135
|
+
### Return type
|
136
|
+
|
137
|
+
[**Array<OrderOnHold>**](OrderOnHold.md)
|
138
|
+
|
139
|
+
### Authorization
|
140
|
+
|
141
|
+
No authorization required
|
142
|
+
|
143
|
+
### HTTP request headers
|
144
|
+
|
145
|
+
- **Content-Type**: application/json
|
146
|
+
- **Accept**: application/json
|
147
|
+
|
148
|
+
|
149
|
+
|
150
|
+
# **get_returns**
|
151
|
+
> ReturnResult get_returns(returns_request_details)
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
Use this operation to retrieve a list of return sales orders for a customer. Successful execution of this method will generate a list of returns from Wineshipping system.
|
156
|
+
|
157
|
+
### Example
|
158
|
+
```ruby
|
159
|
+
# load the gem
|
160
|
+
require 'wine_shipping'
|
161
|
+
|
162
|
+
api_instance = WineShipping::SalesOrderApi.new
|
163
|
+
|
164
|
+
returns_request_details = WineShipping::ReturnsRequest.new # ReturnsRequest |
|
165
|
+
|
166
|
+
|
167
|
+
begin
|
168
|
+
result = api_instance.get_returns(returns_request_details)
|
169
|
+
p result
|
170
|
+
rescue WineShipping::ApiError => e
|
171
|
+
puts "Exception when calling SalesOrderApi->get_returns: #{e}"
|
172
|
+
end
|
173
|
+
```
|
174
|
+
|
175
|
+
### Parameters
|
176
|
+
|
177
|
+
Name | Type | Description | Notes
|
178
|
+
------------- | ------------- | ------------- | -------------
|
179
|
+
**returns_request_details** | [**ReturnsRequest**](ReturnsRequest.md)| |
|
180
|
+
|
181
|
+
### Return type
|
182
|
+
|
183
|
+
[**ReturnResult**](ReturnResult.md)
|
184
|
+
|
185
|
+
### Authorization
|
186
|
+
|
187
|
+
No authorization required
|
188
|
+
|
189
|
+
### HTTP request headers
|
190
|
+
|
191
|
+
- **Content-Type**: application/json
|
192
|
+
- **Accept**: application/json
|
193
|
+
|
194
|
+
|
195
|
+
|
196
|
+
# **replace_sales_order**
|
197
|
+
> replace_sales_order(order_details_info)
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
Use this operation to replace/update an existing open sales order. Successful execution of this method will replace an open sales order in Wineshipping system and will return a transaction reference identifier. Store this identifier back into your system for reference later in the event there is an issue with your replacement order. If the order cannot be replaced for some, reason standard HTTP Status Code and a reason message will be returned.
|
202
|
+
|
203
|
+
### Example
|
204
|
+
```ruby
|
205
|
+
# load the gem
|
206
|
+
require 'wine_shipping'
|
207
|
+
|
208
|
+
api_instance = WineShipping::SalesOrderApi.new
|
209
|
+
|
210
|
+
order_details_info = WineShipping::SalesOrderDetails.new # SalesOrderDetails |
|
211
|
+
|
212
|
+
|
213
|
+
begin
|
214
|
+
api_instance.replace_sales_order(order_details_info)
|
215
|
+
rescue WineShipping::ApiError => e
|
216
|
+
puts "Exception when calling SalesOrderApi->replace_sales_order: #{e}"
|
217
|
+
end
|
218
|
+
```
|
219
|
+
|
220
|
+
### Parameters
|
221
|
+
|
222
|
+
Name | Type | Description | Notes
|
223
|
+
------------- | ------------- | ------------- | -------------
|
224
|
+
**order_details_info** | [**SalesOrderDetails**](SalesOrderDetails.md)| |
|
225
|
+
|
226
|
+
### Return type
|
227
|
+
|
228
|
+
nil (empty response body)
|
229
|
+
|
230
|
+
### Authorization
|
231
|
+
|
232
|
+
No authorization required
|
233
|
+
|
234
|
+
### HTTP request headers
|
235
|
+
|
236
|
+
- **Content-Type**: application/json
|
237
|
+
- **Accept**: application/json
|
238
|
+
|
239
|
+
|
240
|
+
|