Create Item

POST {{baseUrl}}/pos/items?raw=false

Create Item

Request Params

KeyDatatypeRequiredDescription
rawbooleanInclude raw response. Mostly used for debugging purposes

Request Body

{"name"=>"Cocoa", "id"=>"#cocoa", "idempotency_key"=>"random_string", "description"=>"Hot Chocolate", "abbreviation"=>"Ch", "product_type"=>"regular", "price_amount"=>10, "pricing_type"=>"fixed", "price_currency"=>"USD", "cost"=>2, "tax_ids"=>["12345", "67890"], "is_revenue"=>false, "use_default_tax_rates"=>false, "absent_at_location_ids"=>["12345", "67890"], "present_at_all_locations"=>false, "available_for_pickup"=>false, "available_online"=>false, "sku"=>"11910345", "code"=>"11910345", "categories"=>[{"name"=>"Food", "image_ids"=>["12345", "67890"]}], "options"=>[{"id"=>"12345", "name"=>"Option 1", "attribute_id"=>"12345"}, {"id"=>"12345", "name"=>"Option 1", "attribute_id"=>"12345"}], "variations"=>[{"name"=>"Food", "sku"=>"11910345", "item_id"=>"12345", "sequence"=>0, "pricing_type"=>"fixed", "price_amount"=>10, "price_currency"=>"USD", "image_ids"=>["12345", "67890"]}], "modifier_groups"=>[{}], "available"=>true, "hidden"=>true, "deleted"=>true}

HEADERS

KeyDatatypeRequiredDescription
x-apideck-consumer-idstring(Required) ID of the consumer which you want to get or push data from
x-apideck-app-idstring(Required) The ID of your Unify application
x-apideck-service-idstringProvide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Content-Typestring
Acceptstring

RESPONSES

status: Created

{"status_code":200,"status":"OK","service":"square","resource":"Items","operation":"add","data":{"id":"12345"}}