order_cloud 1.0.45.pre.staging → 1.0.57

data/docs/PromotionAssignment.md

@@ -0,0 +1,10 @@
+# OrderCloud::PromotionAssignment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**promotion_id** | **String** |  | [optional] 
+**buyer_id** | **String** |  | [optional] 
+**user_group_id** | **String** |  | [optional] 
+
+

data/docs/SecurityProfile.md

@@ -0,0 +1,10 @@
+# OrderCloud::SecurityProfile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**roles** | **Array<String>** |  | [optional] 
+
+

data/docs/SecurityProfileApi.md

@@ -0,0 +1,292 @@
+# OrderCloud::SecurityProfileApi
+
+All URIs are relative to *https://api.ordercloud.io/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_assignment**](SecurityProfileApi.md#delete_assignment) | **DELETE** /securityprofiles/{securityProfileID}/assignments | 
+[**get**](SecurityProfileApi.md#get) | **GET** /securityprofiles/{securityProfileID} | 
+[**list**](SecurityProfileApi.md#list) | **GET** /securityprofiles | 
+[**list_assignments**](SecurityProfileApi.md#list_assignments) | **GET** /securityprofiles/assignments | 
+[**save_assignment**](SecurityProfileApi.md#save_assignment) | **POST** /securityprofiles/assignments | 
+
+
+# **delete_assignment**
+> delete_assignment(security_profile_id, opts)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::SecurityProfileApi.new
+
+security_profile_id = "security_profile_id_example" # String | ID of the security profile.
+
+opts = { 
+  buyer_id: "buyer_id_example", # String | ID of the buyer.
+  user_id: "user_id_example", # String | ID of the user.
+  user_group_id: "user_group_id_example" # String | ID of the user group.
+}
+
+begin
+  api_instance.delete_assignment(security_profile_id, opts)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling SecurityProfileApi->delete_assignment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **security_profile_id** | **String**| ID of the security profile. | 
+ **buyer_id** | **String**| ID of the buyer. | [optional] 
+ **user_id** | **String**| ID of the user. | [optional] 
+ **user_group_id** | **String**| ID of the user group. | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **get**
+> SecurityProfile get(security_profile_id)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::SecurityProfileApi.new
+
+security_profile_id = "security_profile_id_example" # String | ID of the security profile.
+
+
+begin
+  result = api_instance.get(security_profile_id)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling SecurityProfileApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **security_profile_id** | **String**| ID of the security profile. | 
+
+### Return type
+
+[**SecurityProfile**](SecurityProfile.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list**
+> ListSecurityProfile list(opts)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::SecurityProfileApi.new
+
+opts = { 
+  search: "search_example", # String | Search of the security profile.
+  search_on: ["search_on_example"], # Array<String> | Search on of the security profile.
+  sort_by: ["sort_by_example"], # Array<String> | Sort by of the security profile.
+  page: 56, # Integer | Page of the security profile.
+  page_size: 56, # Integer | Page size of the security profile.
+  filters: {'key' => "filters_example"} # Hash<String, String> | Filters of the security profile.
+}
+
+begin
+  result = api_instance.list(opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling SecurityProfileApi->list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **search** | **String**| Search of the security profile. | [optional] 
+ **search_on** | [**Array&lt;String&gt;**](String.md)| Search on of the security profile. | [optional] 
+ **sort_by** | [**Array&lt;String&gt;**](String.md)| Sort by of the security profile. | [optional] 
+ **page** | **Integer**| Page of the security profile. | [optional] 
+ **page_size** | **Integer**| Page size of the security profile. | [optional] 
+ **filters** | [**Hash&lt;String, String&gt;**](String.md)| Filters of the security profile. | [optional] 
+
+### Return type
+
+[**ListSecurityProfile**](ListSecurityProfile.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list_assignments**
+> ListSecurityProfileAssignment list_assignments(opts)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::SecurityProfileApi.new
+
+opts = { 
+  buyer_id: "buyer_id_example", # String | ID of the buyer.
+  supplier_id: "supplier_id_example", # String | ID of the supplier.
+  security_profile_id: "security_profile_id_example", # String | ID of the security profile.
+  user_id: "user_id_example", # String | ID of the user.
+  user_group_id: "user_group_id_example", # String | ID of the user group.
+  commerce_role: "commerce_role_example", # String | Commerce role of the security profile.
+  level: "level_example", # String | Level of the security profile.
+  page: 56, # Integer | Page of the security profile.
+  page_size: 56 # Integer | Page size of the security profile.
+}
+
+begin
+  result = api_instance.list_assignments(opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling SecurityProfileApi->list_assignments: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | [optional] 
+ **supplier_id** | **String**| ID of the supplier. | [optional] 
+ **security_profile_id** | **String**| ID of the security profile. | [optional] 
+ **user_id** | **String**| ID of the user. | [optional] 
+ **user_group_id** | **String**| ID of the user group. | [optional] 
+ **commerce_role** | **String**| Commerce role of the security profile. | [optional] 
+ **level** | **String**| Level of the security profile. | [optional] 
+ **page** | **Integer**| Page of the security profile. | [optional] 
+ **page_size** | **Integer**| Page size of the security profile. | [optional] 
+
+### Return type
+
+[**ListSecurityProfileAssignment**](ListSecurityProfileAssignment.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **save_assignment**
+> save_assignment(assignment)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::SecurityProfileApi.new
+
+assignment = OrderCloud::SecurityProfileAssignment.new # SecurityProfileAssignment | 
+
+
+begin
+  api_instance.save_assignment(assignment)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling SecurityProfileApi->save_assignment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **assignment** | [**SecurityProfileAssignment**](SecurityProfileAssignment.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+

data/docs/SecurityProfileAssignment.md

@@ -0,0 +1,12 @@
+# OrderCloud::SecurityProfileAssignment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**security_profile_id** | **String** |  | [optional] 
+**buyer_id** | **String** |  | [optional] 
+**supplier_id** | **String** |  | [optional] 
+**user_id** | **String** |  | [optional] 
+**user_group_id** | **String** |  | [optional] 
+
+

data/docs/Shipment.md

@@ -0,0 +1,20 @@
+# OrderCloud::Shipment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**buyer_id** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**shipper** | **String** |  | [optional] 
+**date_shipped** | **String** |  | [optional] 
+**date_delivered** | **String** |  | [optional] 
+**tracking_number** | **String** |  | [optional] 
+**cost** | **Float** |  | [optional] 
+**xp** | **Object** |  | [optional] 
+**account** | **String** |  | [optional] 
+**from_address_id** | **String** |  | [optional] 
+**to_address_id** | **String** |  | [optional] 
+**from_address** | [**Address**](Address.md) |  | [optional] 
+**to_address** | [**Address**](Address.md) |  | [optional] 
+
+

data/docs/ShipmentApi.md

@@ -0,0 +1,554 @@
+# OrderCloud::ShipmentApi
+
+All URIs are relative to *https://api.ordercloud.io/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](ShipmentApi.md#create) | **POST** /shipments | 
+[**delete**](ShipmentApi.md#delete) | **DELETE** /shipments/{shipmentID} | 
+[**delete_item**](ShipmentApi.md#delete_item) | **DELETE** /shipments/{shipmentID}/items/{orderID}/{lineItemID} | 
+[**get**](ShipmentApi.md#get) | **GET** /shipments/{shipmentID} | 
+[**get_item**](ShipmentApi.md#get_item) | **GET** /shipments/{shipmentID}/items/{orderID}/{lineItemID} | 
+[**list**](ShipmentApi.md#list) | **GET** /shipments | 
+[**list_items**](ShipmentApi.md#list_items) | **GET** /shipments/{shipmentID}/items | 
+[**patch**](ShipmentApi.md#patch) | **PATCH** /shipments/{shipmentID} | 
+[**save_item**](ShipmentApi.md#save_item) | **POST** /shipments/{shipmentID}/items | 
+[**update**](ShipmentApi.md#update) | **PUT** /shipments/{shipmentID} | 
+
+
+# **create**
+> Shipment create(shipment)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::ShipmentApi.new
+
+shipment = OrderCloud::Shipment.new # Shipment | 
+
+
+begin
+  result = api_instance.create(shipment)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ShipmentApi->create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **shipment** | [**Shipment**](Shipment.md)|  | 
+
+### Return type
+
+[**Shipment**](Shipment.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **delete**
+> delete(shipment_id)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::ShipmentApi.new
+
+shipment_id = "shipment_id_example" # String | ID of the shipment.
+
+
+begin
+  api_instance.delete(shipment_id)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ShipmentApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **shipment_id** | **String**| ID of the shipment. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **delete_item**
+> delete_item(shipment_id, order_id, line_item_id)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::ShipmentApi.new
+
+shipment_id = "shipment_id_example" # String | ID of the shipment.
+
+order_id = "order_id_example" # String | ID of the order.
+
+line_item_id = "line_item_id_example" # String | ID of the line item.
+
+
+begin
+  api_instance.delete_item(shipment_id, order_id, line_item_id)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ShipmentApi->delete_item: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **shipment_id** | **String**| ID of the shipment. | 
+ **order_id** | **String**| ID of the order. | 
+ **line_item_id** | **String**| ID of the line item. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **get**
+> Shipment get(shipment_id)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::ShipmentApi.new
+
+shipment_id = "shipment_id_example" # String | ID of the shipment.
+
+
+begin
+  result = api_instance.get(shipment_id)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ShipmentApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **shipment_id** | **String**| ID of the shipment. | 
+
+### Return type
+
+[**Shipment**](Shipment.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **get_item**
+> ShipmentItem get_item(shipment_id, order_id, line_item_id)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::ShipmentApi.new
+
+shipment_id = "shipment_id_example" # String | ID of the shipment.
+
+order_id = "order_id_example" # String | ID of the order.
+
+line_item_id = "line_item_id_example" # String | ID of the line item.
+
+
+begin
+  result = api_instance.get_item(shipment_id, order_id, line_item_id)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ShipmentApi->get_item: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **shipment_id** | **String**| ID of the shipment. | 
+ **order_id** | **String**| ID of the order. | 
+ **line_item_id** | **String**| ID of the line item. | 
+
+### Return type
+
+[**ShipmentItem**](ShipmentItem.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list**
+> ListShipment list(opts)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::ShipmentApi.new
+
+opts = { 
+  order_id: "order_id_example", # String | ID of the order.
+  search: "search_example", # String | Search of the shipment.
+  search_on: ["search_on_example"], # Array<String> | Search on of the shipment.
+  sort_by: ["sort_by_example"], # Array<String> | Sort by of the shipment.
+  page: 56, # Integer | Page of the shipment.
+  page_size: 56, # Integer | Page size of the shipment.
+  filters: {'key' => "filters_example"} # Hash<String, String> | Filters of the shipment.
+}
+
+begin
+  result = api_instance.list(opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ShipmentApi->list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_id** | **String**| ID of the order. | [optional] 
+ **search** | **String**| Search of the shipment. | [optional] 
+ **search_on** | [**Array&lt;String&gt;**](String.md)| Search on of the shipment. | [optional] 
+ **sort_by** | [**Array&lt;String&gt;**](String.md)| Sort by of the shipment. | [optional] 
+ **page** | **Integer**| Page of the shipment. | [optional] 
+ **page_size** | **Integer**| Page size of the shipment. | [optional] 
+ **filters** | [**Hash&lt;String, String&gt;**](String.md)| Filters of the shipment. | [optional] 
+
+### Return type
+
+[**ListShipment**](ListShipment.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list_items**
+> ListShipmentItem list_items(shipment_id, opts)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::ShipmentApi.new
+
+shipment_id = "shipment_id_example" # String | ID of the shipment.
+
+opts = { 
+  search: "search_example", # String | Search of the shipment.
+  search_on: ["search_on_example"], # Array<String> | Search on of the shipment.
+  sort_by: ["sort_by_example"], # Array<String> | Sort by of the shipment.
+  page: 56, # Integer | Page of the shipment.
+  page_size: 56, # Integer | Page size of the shipment.
+  filters: {'key' => "filters_example"} # Hash<String, String> | Filters of the shipment.
+}
+
+begin
+  result = api_instance.list_items(shipment_id, opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ShipmentApi->list_items: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **shipment_id** | **String**| ID of the shipment. | 
+ **search** | **String**| Search of the shipment. | [optional] 
+ **search_on** | [**Array&lt;String&gt;**](String.md)| Search on of the shipment. | [optional] 
+ **sort_by** | [**Array&lt;String&gt;**](String.md)| Sort by of the shipment. | [optional] 
+ **page** | **Integer**| Page of the shipment. | [optional] 
+ **page_size** | **Integer**| Page size of the shipment. | [optional] 
+ **filters** | [**Hash&lt;String, String&gt;**](String.md)| Filters of the shipment. | [optional] 
+
+### Return type
+
+[**ListShipmentItem**](ListShipmentItem.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **patch**
+> Shipment patch(shipment_id, shipment)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::ShipmentApi.new
+
+shipment_id = "shipment_id_example" # String | ID of the shipment.
+
+shipment = OrderCloud::Shipment.new # Shipment | 
+
+
+begin
+  result = api_instance.patch(shipment_id, shipment)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ShipmentApi->patch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **shipment_id** | **String**| ID of the shipment. | 
+ **shipment** | [**Shipment**](Shipment.md)|  | 
+
+### Return type
+
+[**Shipment**](Shipment.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **save_item**
+> ShipmentItem save_item(shipment_id, item)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::ShipmentApi.new
+
+shipment_id = "shipment_id_example" # String | ID of the shipment.
+
+item = OrderCloud::ShipmentItem.new # ShipmentItem | 
+
+
+begin
+  result = api_instance.save_item(shipment_id, item)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ShipmentApi->save_item: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **shipment_id** | **String**| ID of the shipment. | 
+ **item** | [**ShipmentItem**](ShipmentItem.md)|  | 
+
+### Return type
+
+[**ShipmentItem**](ShipmentItem.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **update**
+> Shipment update(shipment_id, shipment)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::ShipmentApi.new
+
+shipment_id = "shipment_id_example" # String | ID of the shipment.
+
+shipment = OrderCloud::Shipment.new # Shipment | 
+
+
+begin
+  result = api_instance.update(shipment_id, shipment)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ShipmentApi->update: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **shipment_id** | **String**| ID of the shipment. | 
+ **shipment** | [**Shipment**](Shipment.md)|  | 
+
+### Return type
+
+[**Shipment**](Shipment.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+