Skip to content

Products

Sales items or services being sold.

Products usually belong to product hierarchy which allows one to drill down from top of hierarchy to lower levels in the Zoined Analytics Portal. There are two ways of defining the product hierarchy:

  1. Use FlatHierarchies endpoint with one of the product hierarchy keys entity_id having same product_id value.
  2. Upload product hierarchy using ProductHierarchy endpoint, and add category_id field pointing to correct hierarchy level.
Operations

Upload list of products

Request

POST https://api.zoined.com/products?dryRun=false&separator=%3B&encoding=utf-8

Security
bearerAuth
Query
dryRunbooleanrequired

Only validate the request without storing the data

Example:dryRun=false
separatorstringrequired

Column separator used when loading CSV data

Example:separator=;
encodingstringrequired

Character encoding used in the CSV data (default is utf-8)

Example:encoding=utf-8
Body
Any of:
product_idstringrequired

Product ID

Example:"XYZ"
product_namestringrequired

Product Name

Example:"Widget XYZ"
product_descriptionstring

Product description

Example:"Best performance XYZ on the market"
category_idstring

Product category ID

Example:"23"
average_pricenumber

Running average purchase price for product.

Example:8
purchase_pricenumber

Default purchase price for product. Used if sales transaction doesn't have purchase price set.

Example:10
sales_pricenumber

Default retail price for product with taxes.

Example:20
sales_price_wo_vatnumber

Default retail price for product without taxes.

Example:16
vat_ratenumber

VAT/tax rate

Example:24
unit_of_measurestring

Unit of measure

Example:"PCS"
product_sizestring

Product size

Example:"XS"
product_widthstring

Product width

Example:"5\""
product_heightstring

Product height

Example:"10\""
product_colorstring

Product color

Example:"Dark Blue"
product_typestring

Product type

Example:"Type A"
product_brandstring

Product brand

Example:"Nike"
product_seasonstring

Product season

Example:"Spring"
modelstring

a (string, optional) - Product model

Example:"XYZ B40"
model_numberstring

Product model number

Example:"X311"
country_of_originstring

Country of origin

Example:"Moldovia"
freightnumber

Freight

Example:5
dutynumber

Duty

Example:0.24
supplier_idstring

Supplier ID

Example:"221"
fabricstring

Product fabric

Example:"Felt"
buyerstring

Buyer name

Example:"Lena Shields"
eanstring

Ean code

Example:"Ean code"
parent_product_idstring

Parent Product ID

Example:"XY"
image_urlstring

Url for external product image file

Example:"http://example.com?product=XYZ"
custom_field_1string

Custom field 1

Example:"EU only"
custom_field_2string

Custom field 2

Example:"EU only"
custom_field_3string

Custom field 3

Example:"EU only"
custom_field_4string

Custom field 4

Example:"EU only"
custom_field_5string

Custom field 5

Example:"EU only"
custom_field_6string

Custom field 6

Example:"EU only"
custom_field_7string

Custom field 7

Example:"EU only"
custom_field_8string

Custom field 8

Example:"EU only"
custom_field_9string

Custom field 9

Example:"EU only"
custom_field_10string

Custom field 10

Example:"EU only"
custom_field_11string

Custom field 11

Example:"EU only"
custom_field_12string

Custom field 12

Example:"EU only"
custom_field_13string

Custom field 13

Example:"EU only"
custom_field_14string

Custom field 14

Example:"EU only"
custom_field_15string

Custom field 15

Example:"EU only"
custom_field_16string

Custom field 16

Example:"EU only"
custom_field_17string

Custom field 17

Example:"EU only"
custom_field_18string

Custom field 18

Example:"EU only"
custom_field_19string

Custom field 19

Example:"EU only"
custom_field_20string

Custom field 20

Example:"EU only"
custom_field_21string

Custom field 21

Example:"EU only"
custom_field_22string

Custom field 22

Example:"EU only"
custom_field_23string

Custom field 23

Example:"EU only"
custom_field_24string

Custom field 24

Example:"EU only"
custom_field_25string

Custom field 25

Example:"EU only"
custom_field_26string

Custom field 26

Example:"EU only"
custom_field_27string

Custom field 27

Example:"EU only"
custom_field_28string

Custom field 28

Example:"EU only"
custom_field_29string

Custom field 29

Example:"EU only"
custom_field_30string

Custom field 30

Example:"EU only"
custom_field_31string

Custom field 31

Example:"EU only"
custom_field_32string

Custom field 32

Example:"EU only"
custom_field_33string

Custom field 33

Example:"EU only"
custom_field_34string

Custom field 34

Example:"EU only"
custom_field_35string

Custom field 35

Example:"EU only"
custom_field_36string

Custom field 36

Example:"EU only"
custom_field_37string

Custom field 37

Example:"EU only"
custom_field_38string

Custom field 38

Example:"EU only"
custom_field_39string

Custom field 39

Example:"EU only"
custom_field_40string

Custom field 40

Example:"EU only"
custom_field_41string

Custom field 41

Example:"EU only"
custom_field_42string

Custom field 42

Example:"EU only"
custom_field_43string

Custom field 43

Example:"EU only"
custom_field_44string

Custom field 44

Example:"EU only"
custom_field_45string

Custom field 45

Example:"EU only"
custom_field_46string

Custom field 46

Example:"EU only"
custom_field_47string

Custom field 47

Example:"EU only"
custom_field_48string

Custom field 48

Example:"EU only"
custom_field_49string

Custom field 49

Example:"EU only"
custom_field_50string

Custom field 50

Example:"EU only"
custom_metric_1number

Custom metric 1

Example:1
custom_metric_2number

Custom metric 2

Example:100
custom_metric_3number

Custom metric 3

Example:2.2
custom_metric_4number

Custom metric 4

Example:1.05
custom_metric_5number

Custom metric 5

Example:10000
custom_metric_6number

Custom metric 6

Example:150
custom_metric_7number

Custom metric 7

Example:1000
custom_metric_8number

Custom metric 8

Example:2.52
custom_metric_9number

Custom metric 9

Example:1.5
custom_metric_10number

Custom metric 10

Example:2000
source_systemstring

Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.

Example:"ABCDEF"
curl -i -X POST \
  'https://zapi-api.zoined.com/_mock/products?dryRun=false&separator=%3B&encoding=utf-8' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "product_id": "XYZ",
    "product_name": "Widget XYZ",
    "product_description": "Best performance XYZ on the market",
    "category_id": "23",
    "average_price": 8,
    "purchase_price": 10,
    "sales_price": 20,
    "sales_price_wo_vat": 16,
    "vat_rate": 24,
    "unit_of_measure": "PCS",
    "product_size": "XS",
    "product_width": "5\"",
    "product_height": "10\"",
    "product_color": "Dark Blue",
    "product_type": "Type A",
    "product_brand": "Nike",
    "product_season": "Spring",
    "model": "XYZ B40",
    "model_number": "X311",
    "country_of_origin": "Moldovia",
    "freight": 5,
    "duty": 0.24,
    "supplier_id": "221",
    "fabric": "Felt",
    "buyer": "Lena Shields",
    "ean": "Ean code",
    "parent_product_id": "XY",
    "image_url": "http://example.com?product=XYZ",
    "custom_field_1": "EU only",
    "custom_field_2": "EU only",
    "custom_field_3": "EU only",
    "custom_field_4": "EU only",
    "custom_field_5": "EU only",
    "custom_field_6": "EU only",
    "custom_field_7": "EU only",
    "custom_field_8": "EU only",
    "custom_field_9": "EU only",
    "custom_field_10": "EU only",
    "custom_field_11": "EU only",
    "custom_field_12": "EU only",
    "custom_field_13": "EU only",
    "custom_field_14": "EU only",
    "custom_field_15": "EU only",
    "custom_field_16": "EU only",
    "custom_field_17": "EU only",
    "custom_field_18": "EU only",
    "custom_field_19": "EU only",
    "custom_field_20": "EU only",
    "custom_field_21": "EU only",
    "custom_field_22": "EU only",
    "custom_field_23": "EU only",
    "custom_field_24": "EU only",
    "custom_field_25": "EU only",
    "custom_field_26": "EU only",
    "custom_field_27": "EU only",
    "custom_field_28": "EU only",
    "custom_field_29": "EU only",
    "custom_field_30": "EU only",
    "custom_field_31": "EU only",
    "custom_field_32": "EU only",
    "custom_field_33": "EU only",
    "custom_field_34": "EU only",
    "custom_field_35": "EU only",
    "custom_field_36": "EU only",
    "custom_field_37": "EU only",
    "custom_field_38": "EU only",
    "custom_field_39": "EU only",
    "custom_field_40": "EU only",
    "custom_field_41": "EU only",
    "custom_field_42": "EU only",
    "custom_field_43": "EU only",
    "custom_field_44": "EU only",
    "custom_field_45": "EU only",
    "custom_field_46": "EU only",
    "custom_field_47": "EU only",
    "custom_field_48": "EU only",
    "custom_field_49": "EU only",
    "custom_field_50": "EU only",
    "custom_metric_1": 1,
    "custom_metric_2": 100,
    "custom_metric_3": 2.2,
    "custom_metric_4": 1.05,
    "custom_metric_5": 10000,
    "custom_metric_6": 150,
    "custom_metric_7": 1000,
    "custom_metric_8": 2.52,
    "custom_metric_9": 1.5,
    "custom_metric_10": 2000,
    "source_system": "ABCDEF"
  }'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
statusstringrequired

Status of the operation OK / Not OK

Example:"OK"
msgstringrequired

Message describing result of operation

Example:"1 entity added"
Response
{
  "status": "OK",
  "msg": "1 entity added"
}