Versions Compared

Old Version 2

changes.mady.by.user Joe Wagner

Saved on

compared with

New Version 3

changes.mady.by.user Alan Gilchrist

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

The purpose of this service is to save new products to Vision database,

Request

Request URL POST : https://<pathtoapi>/service/ProductCode

POST Body structure : PC XML Structure

Expand
titleRequest body sample
Code Block
languagexml
<?xml version="1.0" standalone="yes"?> 
<PRODUCTS>
    <PC>
        <HD>
            <CustomerCode>CUST01</CustomerCode>
            <SiteCode>TH</SiteCode>
            <CountryOfOrigin />
            <ProductCode>PRO1</ProductCode>
            <ProductDescription>king</ProductDescription>
            <NetWeightKG>1.0000</NetWeightKG>
            <GrossWeightKG>1.7000</GrossWeightKG>
            <SinglesPerUnit>1</SinglesPerUnit>
            <SingleSize>1.0000</SingleSize>
            <ReserveCustomer xml:space="preserve"> </ReserveCustomer>
        </HD>
        <HO>
            <ProductType>0</ProductType>
            <BrandName>king</BrandName>
            <KilogramsPerUnit />
            <UnitsPerPallet>1</UnitsPerPallet>
            <Height />
            <StrengthABV />
            <LitresLiquidPerUnit />
            <LitresAlcoholPerUnit />
            <CigarettesPerUnit />
            <ProductGroupCode />
            <VatCode />
            <CommodityCode />
            <CountryWhenceConsigned />
            <TaxCode />
            <UnitToChargeBy />
            <PackageDescription />
            <AlternativeCode />
            <AlternativeDescription />
            <UnitsPerLayer>1</UnitsPerLayer>
            <ContainerQuantity />
            <MinStockLevel />
            <MinPurchaseOrderQuantity />
            <MinSalesOrderQuantity />
            <TraderUnitCode />
            <SubUnitCode />
            <UsePackageQuantity />
            <IsSerialNumberRequired />
            <CarriagePricePerUnit />
            <CIFPricePerUnit />
            <SalesPricePerUnit />
            <UnderBondSalesPricePerUnit />
            <PurchaseCostPerUnit />
            <InsuranceCostPerUnit />
            <SubtituteProduct1 />
            <SubtituteProduct2 />
            <SubtituteProduct3 />
            <CigarettesSellingPricePerUnit />
            <ProductLife />
            <ShelfLifeDays />
            <ProductCostPerUnit />
            <ProductCostCurrency />
            <InsuranceCostCurrency />
            <FreightCostCurrency />
            <vintage>1990</vintage>
        </HO>
    </PC>
</PRODUCTS>

Response

Response body will have new tag <RES> attached with input XML which will have information about the response.

...

Code will be 200 or 400, 200 is for success, if the code is 400 node <Message> will have reason for failure

HTTP Response Codes

Code

Message

200

OK, All request processed

406

Input XML validation failed, response body will have reason for failure

429

API access restricted (Exceeded the rate limit / access not allowed)

207

Multi-Status, <RES> tag have more information

400

Request processing all record failed, <RES> tag have more information

Response samples

Code : 200

Code Block
languagexml
<PRODUCTS>
    <PC>
        <HD>
            <ProductCode>PRO1</ProductCode>
        </HD>
        <RES>
            <Code>200</Code>
            <Message>ProductCode processed</Message>
        </RES>
    </PC>
    <PC>
        <HD>
            <ProductCode>PRO2</ProductCode>
        </HD>
        <RES>
            <Code>200</Code>
            <Message>ProductCode processed</Message>
        </RES>
    </PC>
</PRODUCTS>

Code : 207

Code Block
languagexml
<PRODUCTS>
    <PC>
        <HD>
            <ProductCode>PRO1</ProductCode>
        </HD>
        <RES>
            <Code>200</Code>
            <Message>ProductCode processed</Message>
        </RES>
    </PC>
    <PC>
        <HD>
            <ProductCode>PRO2</ProductCode>
        </HD>
        <RES>
            <Code>400</Code>
            <Message>Validation failure occurred on line: 1 Product Code is mandatory</Message>
        </RES>
    </PC>
</PRODUCTS>

Code : 400

Code Block
languagexml
<PRODUCTS>
    <PC>
        <HD>
            <ProductCode>PRO1</ProductCode>
        </HD>
       <RES>
            <Code>400</Code>
            <Message>Validation failure occurred on line: 1 Product Code is mandatory</Message>
        </RES>
    </PC>
    <PC>
        <HD>
            <ProductCode>PRO2</ProductCode>
        </HD>
        <RES>
            <Code>400</Code>
            <Message>Validation failure occurred on line: 1 Product Code is mandatory</Message>
        </RES>
    </PC>
</PRODUCTS>

Code : 406 Response Body

Code Block
Failed validation because field 'SiteCode' exceeded the maximum number of characters allowed.

...