DocsUser GuidesAPIChangelog

Axiom API Docs

Overview
Endpoints
Authentication
Stores
Batch Uploads
Batch Requests
Products
List Products
get
Create Product
post
Show Product
get
Update Product
put
Delete Product
delete
List Product Archives
get
Restore Product
post
Product Variants
Price Lists
Promotions
Categories
URLs
Codes
Properties
Options
Disable
Stocks
Resource Codes
Quotation
Request For Quotation
powered by Stoplight

Create Product

post
https://api.axiomdata.io/api
/suppliers/products

Quickly add products with this endpoint, categorizing them into simple or complex, where complex represent products with various variants.

Request

Headers

UserAccountId
integer

[Optional] Only provide if you have access to multiple user accounts.

Body

Complex product object with variants

product_identifier
string
required
name
string
required
<= 191 characters
type
string
required
Allowed values:
simplecomplex
brand
string
required
<= 191 characters
manufacturer
string
required
<= 191 characters
sku
string
required

required only if type is simple

<= 191 characters
language_code
string
Example:
en
product_page_url
string
Example:
https://axiomdata.com
prices
array[object]
required

this property is not necessary if type is complex

price
number
country
string

provide country code

Example:
de
currency
string

provide currency code

Example:
eur
store_id
integer
public_price
number

the publicly available price for this product

stocks
array[object]

this property is not necessary if type is complex

country_code
string
Example:
AU
lead_time_days
integer
>= 0
stock
integer

the amount of stock available

>= 1
always_available
boolean
unit_label
string
required

required only if type is simple

<= 191 characters
unit_size
string
required

required only if type is simple

<= 191 characters
categories
array[string]
Example:
["Home","Blotting Apparatus"]
properties
object
Example:
{'tests': 'tube2'}
codes
array[object]
required

prohibited if type is complex and required if type is simple

code
string
required
type
string
required

unspsc and mpn must be provided

Allowed values:
upceanmpnitf-14janunspschscasinchiinchikey
version
string

required only if type is unspsc

<= 191 characters
shipping_detail
array[object]
weight
array
required
Example:
{"unit":"cm","value":12.11}
length
array
required
Example:
{"unit":"cm","value":13.5}
width
array
required
Example:
{"unit":"cm","value":25.7}
height
array
required
Example:
{"unit":"lb","value":12.1}
country_code
string
required
Example:
AU
document_urls
array[object]
name
string
required
<= 191 characters
Example:
Axiom Site
url
string
required
Example:
https://axiomdata.com
image_urls
array[string]
Example:
["https://axiomdata.com","https://url.com"]
variants
array[object]

prohibited if type is simple, properties are same as product object properties above with a different properties below

variant_identifier
string
options
array[object]
Example:
[{"name":"color","value":"red"},{"name":"size","value":"small"}]

Responses

Successful response

Body

Auth
:
Parameters
:
Body
curl --request POST \
  --url https://api.axiomdata.io/api/suppliers/products \
  --header 'Authorization: Bearer undefined' \
  --header 'Content-Type: application/json' \
  --header 'UserAccountId: ' \
  --data '{
  "name": "BeeBlot™ Automated Immunoblot Processor, Gold Standard Diagnostic",
  "type": "simple",
  "language_code": "de",
  "brand": "Example Brand",
  "manufacturer": "Example Manufacturer",
  "sku": "1234455",
  "prices": [
    {
      "price": "38467.37",
      "country": "DE",
      "currency": "EUR"
    }
  ],
  "unit_label": "EA",
  "unit_size": "123123",
  "categories": [
    "Home",
    "Blotting Apparatus"
  ],
  "codes": [
    {
      "code": "12312332",
      "type": "MPN"
    }
  ],
  "product_identifier": "jgisovcjbn"
}'
1
{
2
  "id": 14516,
3
  "type": "simple",
4
  "name": "simple_identifier",
5
  "description": "<p>Entris® II — Best value in its cass for basic weighing tasks.</p>",
6
  "manufacturer": "SARTORIUS Lab Instru",
7
  "created_at": "2024-05-21T06:19:01.000000Z",
8
  "updated_at": "2024-05-21T06:19:01.000000Z",
9
  "product_identifier": "simple_identifier",
10
  "unit_size": "EA",
11
  "unit_label": "AE",
12
  "uuid": "580764bd-5ae1-4f95-b052-58aacd32220a",
13
  "product_page_url": "https://huberlab.ch/huberlab/en/CHF/p/HUB_100042",
14
  "brand": "SARTORIUS Lab Instru",
15
  "sku": "simple_identifier",
16
  "codes": [
17
    {
18
      "id": 45515,
19
      "type": "CAS",
20
      "code": "9170972-51-8",
21
      "is_automatic": false,
22
      "created_at": "2024-05-21T06:19:01.000000Z",
23
      "updated_at": "2024-05-21T06:19:01.000000Z"
24
    },
25
    {
26
      "id": 45516,
27
      "type": "INCHI",
28
      "code": "InChI=1S/C5MVT2UGBHJ/",
29
      "is_automatic": false,
30
      "created_at": "2024-05-21T06:19:01.000000Z",
31
      "updated_at": "2024-05-21T06:19:01.000000Z"
32
    },
33
    {
34
      "id": 45517,
35
      "type": "INCHIKEY",
36
      "code": "AUPJAUJDCMAFTT-BXUPTKGNSS-X",
37
      "is_automatic": false,
38
      "created_at": "2024-05-21T06:19:01.000000Z",
39
      "updated_at": "2024-05-21T06:19:01.000000Z"
40
    },
41
    {
42
      "id": 45518,
43
      "type": "MPN",
44
      "code": "qweq",
45
      "is_automatic": false,
46
      "created_at": "2024-05-21T06:19:01.000000Z",
47
      "updated_at": "2024-05-21T06:19:01.000000Z"
48
    },
49
    {
50
      "id": 45519,
51
      "type": "INCHI",
52
      "code": "InChI=1S/C5MVT2UAMIER/",
53
      "is_automatic": false,
54
      "created_at": "2024-05-21T06:19:01.000000Z",
55
      "updated_at": "2024-05-21T06:19:01.000000Z"
56
    },
57
    {
58
      "id": 45520,
59
      "type": "UNSPSC",
60
      "code": "41100000",
61
      "is_automatic": false,
62
      "created_at": "2024-05-21T06:19:01.000000Z",
63
      "updated_at": "2024-05-21T06:19:01.000000Z"
64
    }
65
  ],
66
  "properties": [
67
    {
68
      "id": 72376,
69
      "product_property_id": 475,
70
      "is_automatic": false,
71
      "created_at": "2024-05-21T06:19:01.000000Z",
72
      "updated_at": "2024-05-21T06:19:01.000000Z",
73
      "property": "Description",
74
      "value": "Advanced Line, external Adjustment"
75
    }
76
  ],
77
  "image_urls": [
78
    {
79
      "id": 124943,
80
      "name": null,
81
      "type": "image",
82
      "url": "https://www.huberlab.ch//medias/HUB-100041-1.jpg",
83
      "created_at": "2024-05-21T06:19:01.000000Z",
84
      "updated_at": "2024-05-21T06:19:01.000000Z"
85
    }
86
  ],
87
  "document_urls": [
88
    {
89
      "id": 124944,
90
      "name": "docu 1",
91
      "type": "document",
92
      "url": "https://google.com",
93
      "created_at": "2024-05-21T06:19:01.000000Z",
94
      "updated_at": "2024-05-21T06:19:01.000000Z"
95
    },
96
    {
97
      "id": 124945,
98
      "name": "docu 2",
99
      "type": "document",
100
      "url": "https://google.com",
101
      "created_at": "2024-05-21T06:19:01.000000Z",
102
      "updated_at": "2024-05-21T06:19:01.000000Z"
103
    }
104
  ],
105
  "variants": [],
106
  "categories": [
107
    {
108
      "id": 393,
109
      "parent_id": null,
110
      "name": "Assortment",
111
      "created_at": "2024-02-19T06:19:38.000000Z",
112
      "updated_at": "2024-02-19T06:19:38.000000Z"
113
    }
114
  ],
115
  "shipping_detail": {
116
    "id": 3,
117
    "height": {
118
      "unit": "cm",
119
      "value": 12.11
120
    },
121
    "width": {
122
      "unit": "cm",
123
      "value": 25.7
124
    },
125
    "length": {
126
      "unit": "cm",
127
      "value": 13.5
128
    },
129
    "weight": {
130
      "unit": "lb",
131
      "value": 12.34
132
    },
133
    "created_at": "2024-05-21T06:19:01.000000Z",
134
    "updated_at": "2024-05-21T06:19:01.000000Z",
135
    "country": {
136
      "id": 231,
137
      "name": "UK",
138
      "code": "GB"
139
    }
140
  },
141
  "ships_to": []
142
}