Choco Product XML
This XML format represents products in Choco.
Tasks
Minimal XML Sample
The XML below represents the minimum information that needs to be provided to create a product in Choco.
<?xml version="1.0"?>
<Products>
<Product>
<ExternalId>TEST0001</ExternalId>
<Name>Baked Beans</Name>
<Unit>Case</Unit>
</Product>
</Products>
Product
The following information can be provided for the products:
XML Field | Example | Field Type | Input | Description |
---|---|---|---|---|
ZynkExternalId | 12345 | string | Optional | Used in conjunction with the Prevent Reprocessing setting. Max 255 chars |
Id | ead4d187-4e4e-4a4b-8a1c-61fe79591b16 | guid | Optional | Choco's internal identifier for the product |
ExternalId | TEST0001 | string | Required | The ID of the product |
Name | Baked Beans | string | Required | The name of the product |
Description | Delicious Baked Beans | string | Optional | An extended description of the product |
CategoryName | Tinned Goods | string | Optional | The name of the product category |
SubCategoryName | Multipacks | string | Optional | The name of the product sub-category |
IsActive | true | bool | Optional | If set to false, the prodcut will be unavailable for order |
Unit | Case | string | Required | The unit of measure the product is ordered in |
PackSize | 12 Cans | string | Optional | A free text description of the contents of one package. |
UnitPrice/Currency | GBP | string | Dependant | The ISO 4217 currency code. Required when UnitPrice/Amount is specified |
UnitPrice/Amount | 10.99 | decimal | Optional | The unit price of the product. |
LeadTimeDays | 3 | integer | Optional | The lead time in days. |
CutOffTime | 11:00 | string | Optional | The point in time before which the order should be posted for it to be delivered on this day. |
Brand | Heinz | string | Optional | The brand name of the product |
Ean | 9780521425575 | string | Optional | The product's EAN barcode |
Upc | 036000291452 | string | Optional | The universal product code |
Origin | GB | string | Optional | The country code of origin, specified using the ISO 3166-1 alpha-2 standard |
<?xml version="1.0"?>
<Products>
<Product>
<ZynkExternalId>12345</ZynkExternalId>
<Id>ead4d187-4e4e-4a4b-8a1c-61fe79591b16</Id>
<ExternalId>TEST0001</ExternalId>
<Name>Baked Beans</Name>
<Description>Delicious Baked Beans</Description>
<CategoryName>Tinned Goods</CategoryName>
<SubCategoryName>Multipacks</SubCategoryName>
<IsActive>true</IsActive>
<Unit>Case</Unit>
<PackSize>12 Cans</PackSize>
<UnitPrice>
<Currency>GBP</Currency>
<Amount>10.99</Amount>
</UnitPrice>
<LeadTimeDays>3</LeadTimeDays>
<CutOffTime>11:00</CutOffTime>
<Brand>Heinz</Brand>
<Ean>9780521425575</Ean>
<Upc>036000291452</Upc>
<Origin>GB</Origin>
</Product>
</Products>