APIs for managing product data in Erudus. An API key with appropriate write permissions for managing product data and an account associated with the manufacturer is required.
Create Product
post
Create a new Erudus product. This action takes a JSON object as the request’s body, containing a product and an array of inner components.
The schema determines which data attributes are required and what validations will be performed on the data submitted. View the schema browser to view required parameters.
An HTTP error status code 422 is returned if any data fails validation. The JSON body of the error response will include details of any such errors.
Authorizations
AuthorizationstringRequired
You can retrieve your token by visiting your dashboard and clicking Manage API tokens.
Body
manufacturer_product_namestringRequired
Manufacturers Product Name
product_namestringRequired
Product Name
manufacturerintegerRequired
Manufacturer Name
labelintegerOptional
Brand Owner
brandintegerOptional
Brand
schemastringRequired
Specification Type
manufacturer_product_codestringRequired
Manufacturer Product Code
product_descriptionstringRequired
Product Description
product_typestringRequired
Product Type
product_categorystringRequired
Product Category
storage_typestringRequired
Storage Type
manufacturer_addressintegerOptional
Manufacturer Address
marketing_descriptionstringOptional
Marketing Description
day_codestringOptional
Day Code
batch_codestringOptional
Batch Code
manufacturer_version_numberstringOptional
Manufacturer Version Number
effective_datestringOptional
Effective Date
no_outer_presentintegerOptional
No Outer Case Present?
traded_unit_gtinstringOptional
Outer Case GTIN
variable_inner_componentsintegerOptional
Variable Inner Components in Outer Case
consumer_units_per_tradednumberOptional
Total Quantity of Inner Components in Outer Case
outer_case_gross_weightnumberOptional
Outer Case Gross Weight
outer_case_heightnumberOptional
Outer Case Height
outer_case_depthnumberOptional
Outer Case Depth
outer_case_net_weightnumberOptional
Outer Case Net Weight
outer_case_widthnumberOptional
Outer Case Width
trade_item_splittableintegerOptional
Is the Outer Case Splittable?
value_added_tax_rateintegerOptional
Value Added Tax Rate
inner_packs_in_casenumberOptional
Total Quantity of Inner Packs in Outer Case
inner_pack_heightnumberOptional
Inner Pack Height
inner_pack_depthnumberOptional
Inner Pack Depth
inner_pack_widthnumberOptional
Inner Pack Width
inner_pack_gtinstringOptional
Inner Pack GTIN
inner_pack_splittableintegerOptional
Is Inner Pack Splittable?
inner_pack_gross_weightnumberOptional
Inner Pack Gross Weight
inner_pack_gross_weight_unitsstringOptional
Inner Pack Gross Units
inner_pack_net_weightnumberOptional
Inner Pack Net Weight
inner_pack_net_weight_unitsstringOptional
Inner Pack Net Units
inner_components_in_packnumberOptional
Quantity of Inner Components in Inner Pack
inner_pack_product_codestringOptional
Inner Pack Product Code
product_health_warningstringOptional
Product Health Warning
age_restricted_productintegerOptional
Age Restricted Product
age_restrictionnumberOptional
Age Restriction
non_palletisedintegerRequired
Non Palletised
pallet_typeintegerOptional
Pallet Type
pallet_gtinstringOptional
Pallet GTIN
cases_per_palletnumberOptional
Quantity of Cases Per Pallet
pallet_gross_weightnumberOptional
Pallet Gross Weight
pallet_heightnumberOptional
Pallet Height
cases_per_pallet_layernumberOptional
Quantity of Cases Per Pallet Layer
layers_per_palletnumberOptional
Quantity of Layers Per Pallet
max_shelf_lifenumberOptional
Shelf Life from Time of Production
shelf_life_from_openingnumberOptional
Shelf Life From Opening
shelf_life_exemptintegerOptional
Exempt From Shelf Life Labelling
manufacturer_commentsstringOptional
Manufacturer Comments
Responses
201
Success
application/json
403
Action unauthorised.
application/json
422
Validation failed
application/json
post
/v2/products
Update Product
put
Update an existing Erudus product. This action takes a JSON object as the request’s body, containing a product and an array of inner components.
The schema determines which data attributes are required and what validations will be performed on the data submitted.
An HTTP error status code 422 is return if any data fails validation. The JSON body of the error response will include details of any such errors.
Authorizations
AuthorizationstringRequired
You can retrieve your token by visiting your dashboard and clicking Manage API tokens.
Path parameters
productstringRequired
The Erudus ID of the product.
Example: 7bc42964412a4566b3daa77bd6daf275
Body
manufacturer_product_namestringRequired
Manufacturers Product Name
product_namestringRequired
Product Name
brandintegerOptional
Brand
schemastringRequired
Specification Type
manufacturer_product_codestringRequired
Manufacturer Product Code
product_descriptionstringRequired
Product Description
product_typestringRequired
Product Type
product_categorystringRequired
Product Category
storage_typestringRequired
Storage Type
manufacturer_addressintegerOptional
Manufacturer Address
marketing_descriptionstringOptional
Marketing Description
day_codestringOptional
Day Code
batch_codestringOptional
Batch Code
manufacturer_version_numberstringOptional
Manufacturer Version Number
effective_datestringOptional
Effective Date
no_outer_presentintegerOptional
No Outer Case Present?
traded_unit_gtinstringOptional
Outer Case GTIN
variable_inner_componentsintegerOptional
Variable Inner Components in Outer Case
consumer_units_per_tradednumberOptional
Total Quantity of Inner Components in Outer Case
outer_case_gross_weightnumberOptional
Outer Case Gross Weight
outer_case_heightnumberOptional
Outer Case Height
outer_case_depthnumberOptional
Outer Case Depth
outer_case_net_weightnumberOptional
Outer Case Net Weight
outer_case_widthnumberOptional
Outer Case Width
trade_item_splittableintegerOptional
Is the Outer Case Splittable?
value_added_tax_rateintegerOptional
Value Added Tax Rate
inner_packs_in_casenumberOptional
Total Quantity of Inner Packs in Outer Case
inner_pack_heightnumberOptional
Inner Pack Height
inner_pack_depthnumberOptional
Inner Pack Depth
inner_pack_widthnumberOptional
Inner Pack Width
inner_pack_gtinstringOptional
Inner Pack GTIN
inner_pack_splittableintegerOptional
Is Inner Pack Splittable?
inner_pack_gross_weightnumberOptional
Inner Pack Gross Weight
inner_pack_gross_weight_unitsstringOptional
Inner Pack Gross Units
inner_pack_net_weightnumberOptional
Inner Pack Net Weight
inner_pack_net_weight_unitsstringOptional
Inner Pack Net Units
inner_components_in_packnumberOptional
Quantity of Inner Components in Inner Pack
inner_pack_product_codestringOptional
Inner Pack Product Code
product_health_warningstringOptional
Product Health Warning
age_restricted_productintegerOptional
Age Restricted Product
age_restrictionnumberOptional
Age Restriction
non_palletisedintegerRequired
Non Palletised
pallet_typeintegerOptional
Pallet Type
pallet_gtinstringOptional
Pallet GTIN
cases_per_palletnumberOptional
Quantity of Cases Per Pallet
pallet_gross_weightnumberOptional
Pallet Gross Weight
pallet_heightnumberOptional
Pallet Height
cases_per_pallet_layernumberOptional
Quantity of Cases Per Pallet Layer
layers_per_palletnumberOptional
Quantity of Layers Per Pallet
max_shelf_lifenumberOptional
Shelf Life from Time of Production
shelf_life_from_openingnumberOptional
Shelf Life From Opening
shelf_life_exemptintegerOptional
Exempt From Shelf Life Labelling
manufacturer_commentsstringOptional
Manufacturer Comments
Responses
200
Success
application/json
403
Action unauthorised.
application/json
422
Validation failed
application/json
put
/v2/products/{product}
Archive Product
put
Sets the status of the product to archived. Archived products still exist in the system.
Wholesalers with products in their range will continue to be able to view the archived product, but the product will no longer appear in searches.
You may unarchive a product using the main web application in the Manufacturer dashboard.
Authorizations
AuthorizationstringRequired
You can retrieve your token by visiting your dashboard and clicking Manage API tokens.