Skip to content

Latest commit

 

History

History
38 lines (32 loc) · 2.19 KB

ProductItemRequest.md

File metadata and controls

38 lines (32 loc) · 2.19 KB

ClickAndDrop::ProductItemRequest

Properties

Name Type Description Notes
name String [optional]
sku String The presence or not of field <b>SKU</b> and other fields in the request body will determine which of the following behaviours occur:- <br>1) A minimum of <b>SKU</b>, <b>unitValue</b>, <b>unitWeightInGrams</b> and <b>quantity</b> provided - In addition to the provided product fields being used for the order creation, an existing account Product with matching SKU will be overwritten with all provided product parameters. If no existing account Product with matching SKU can be found then a new product will be created with the provided SKU and product parameters.<br>2) <b>SKU</b>, <b>quantity</b> provided and <b>no other fields</b> provided - An account Product with the provided SKU will be used for the order if it exists.<br>3) <b>SKU not provided</b> and a minimum of <b>unitValue</b>, <b>unitWeightInGrams</b> and <b>quantity</b> provided - All provided product fields will be used for the order creation.<br>4) All other scenarios will result in a validation error. [optional]
quantity Integer
unit_value Float [optional]
unit_weight_in_grams Integer [optional]
customs_description String [optional]
extended_customs_description String [optional]
customs_code String [optional]
origin_country_code String [optional]
customs_declaration_category String [optional]
requires_export_licence Boolean [optional]

Example

require 'click_and_drop'

instance = ClickAndDrop::ProductItemRequest.new(
  name: null,
  sku: null,
  quantity: null,
  unit_value: null,
  unit_weight_in_grams: null,
  customs_description: null,
  extended_customs_description: null,
  customs_code: null,
  origin_country_code: null,
  customs_declaration_category: null,
  requires_export_licence: null
)