This method returns the Winbiz Items. This method uses a pagination in order to avoid to stress the API with useless calls and returns. The Class returned always contains 100 items at the most.

Pay attention to the fact that this method returns, for the moment, also the pictures associated to the items. We're going to add a parameter that allows not to return the pictures, but in the meantime you must take into consideration that pictures will slow down the delivery of the results.

BODY - RAW

{
      "Method": "Products",
      "Parameters": [
            [<nLastItemId>],
            [<dModifiedSince>],
            [<cItemList>],
            [<bOnlyEcommerce>],
            [<nPriceRound>],
            [<cCurrencyCode>],
            [<nPriceTableId>],
            [<cCategoryName>],
            [<bNoPictures>]       ] }

PARAMETERS

Property Description
nLastItemId

ID of the first item to be returned. You'll typically parse the results of a call, and then pass as a parameter the biggest (last) ID received, in order to obtain the next 100 products.

If the method returns less than 100 Products, that means that it has returned everything (according to the parameters used)

dModifiedSince

Allows to return only the items changed/created/deleted since the date passed as a parameter.

cItemList

 A list of ID, separated by semi-columns to use as a filter.

bOnlyEcommerce

Allows to return only the items that are flagged as items to be published to a e-commerce site.

nPriceRound

Rounding method to be used to round prices. the possible values are:

- 0 où 1 - arrondi à 1ct

- 2 - arrondi à 5ct

- 3 arrondi à 1chf

cCurrencyCode

ISO Code of the currency in which the prices has to be returned.

nPriceTableNr

Number of the price table to be returned

cCategoryName

Name of the only category to be returned

bNoPictures

Allows not to return the pictures associates with the items. 

 

EXAMPLE

*/ Return the first 100 items

{
      "Method": "Products",
      "Parameters": [
            0
       ]
}

*/ Return the first 100 items having an ID (ar_numero) bigger than 54879

{
      "Method": "Products",
      "Parameters": [
            54789
       ]
}

*/ Return the first 100 items created or modified after the 01.01.2017.

{
      "Method": "Products",
      "Parameters": [
            0,
            "2017-01-01"
      ]
}

*/ Return the first 100 items having an ID (ar_numero) bigger than 23487 and having been created or modified after the 01.01.2017.

{
      "Method": "Products",
      "Parameters": [
            23487,
            "2017-01-01"
      ]
}

 

CLASS RETURNED

Property Description
Id

Item id

StockQuantity

Quantity available in stock

Code

Item Code (ar_code)

BarCode

Item BarCode

Price

Item price (according to the parameters passed to the method).

PurchasePrice

Item purchase price

CreationDate

Date of the creation of the item

LastUpdateDate

Date of the last modification of the item

Unit

Item unit

Weight

Weight of the article in kg

Availability True means that the item can be sold. False means that the item is not resellable anymore.
AccountingMethod

Id of the accounting method of the item.

More details about the AccountingMethod (VAT rate, Included or Not included, etc.) can be returned via the method CptMod.

ShortDescriptionFrench Short description of the item, in french
ShortDescriptionGerman Short description of the item, in german
ShortDescriptionItalian Short description of the item, in italian
ShortDescriptionEnglish Short description of the item, in english
ShortDescriptionOtherLanguage Short description of the item, in the language specified as Other in Winbiz
LongDescriptionFrench Long description of the item, in french
LongDescriptionGerman Long description of the item, in german
LongDescriptionItalian Long description of the item, in italian
LongDescriptionEnglish Long description of the item, in english
LongDescriptionOtherLanguage Long description of the item, in the language specified as Other in Winbiz
CategoryId Id of the Category of the Item
BrandId Id of the Brand of the Item
MiscellaneousField1 Miscellaneaous Field number 1
MiscellaneousField2 Miscellaneaous Field number 2
MiscellaneousField3 Miscellaneaous Field number 3
MiscellaneousField4 Miscellaneaous Field number 4
MiscellaneousField5 Miscellaneaous Field number 5
MiscellaneousField6 Miscellaneaous Field number 6
MiscellaneousField7 Miscellaneaous Field number 7
MiscellaneousField8 Miscellaneaous Field number 8
MiscellaneousField9 Miscellaneaous Field number 9
MiscellaneousField10 Miscellaneaous Field number 10
MiscellaneousField11 Miscellaneaous Field number 11
MiscellaneousField12 Miscellaneaous Field number 12
Pictures Pictures, encoded in base 64, that are associated to each Item

 

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.