GetBasket
Updated on
Delivers the shopping basket datasets of the stated program, which correspond with
the consigned filter, as well as the history ID of the newly-created export entry.
the consigned filter, as well as the history ID of the newly-created export entry.
Input
<GetBasket xmlns="http://services.zanox.com/erp">
<programid>10</programid>
<basketfilter xmlns="http://services.zanox.com/erp/Export">
<period from="2004-12-01T00:00:00+02:00"
to="2004-12-31T23:00:00+02:00"/>
<reviewstate negate="1">1
<reviewstate>
<category status="1"/>
<orderid negate="1">TestKat</orderid>
</basketfilter>
</GetBasket>
| Object | Data type | Characters | Description | Mandatory? |
|---|---|---|---|---|
<programid> | int | ID of the program whose data will be retrieved | x | |
<basketfilter> | Filter criteria, which will be applied during the export | x | ||
<period> | Export period | x | ||
| from | datetime | Most recent time stamp of the dataset | x | |
| to | datetime | Oldest time stamp of the dataset | x | |
<reviewstate> | int | Review status of the sales to which the shopping basket appertains | ||
| negate | boolean | Criterion <reviewstate>should • 0 = not be negated • 1 = be negated | ||
<category> | Tracking category of the dataset at zanox | |||
| status | byte | Status of the tracking category is • 1 = known • 2 = unknown | ||
<orderid> | normalizedstring | 50 | Order ID of the dataset | |
| negate | boolean | Criterion <orderid> should • 0 = not be negated • 1 = be negated |
|
If the value of the "negate" attribute of the orderid element is 1, all datasets that do not
correspond with the condition will be exported.
Output
If the lock wait time has not yet expired and the user wishes to carry out a new data export,
the request will be terminated with an error (refer to <locktime> element in GetUserPrograms).
| Object | Data type | Description |
|---|---|---|
| <historyid> | int | History ID that was created for the export process |
Otherwise, zanox ERP Web Services delivers the following data:
<GetBasketResponse xmlns="http://services.zanox.com/erp">
<basketdata>
<basket id="a5028acb-23b2-4b42-9edf-70ff0ac04167" trackingtype="23" xmlns="http://services.zanox.com/erp/Export">
<click>
<ulp>string</ulp>
</click>
<request timestamp="2004-06-18 12:16:28"/>
<program id="10"/>
<order id="1396525"/>
<category id="Ihre-Kategorie"/>
<affiliate>
<commission currency="EUR">0.66</commission>
</affiliate>
<product number="1234" quantity="1">
<name>productname</name>
<price currency="EUR">8.15</price>
</product>
<commission fix="0.20" percent="0.15"/>
</basket>
...
</basketdata>
<GetBasketResponse>
| Object | Data type | Description |
|---|---|---|
<basketdata> | Contains n elements <basket> as children | |
| <basket> | Contains information on the shopping basket dataset | |
| id | normalizedstring | Unique ID of the shopping basket dataset (GUID) |
| trackingtype | unsignedbyte | Tracking type for which the dataset was tracked |
<click> | ||
<ulp> | normalizedstring | Transmitted ULP |
<request> | ||
| timestamp | datetime | Time stamp of the request |
<program> | ||
| id | int | ID of the program to which the dataset pertains |
<order> | ||
| id | normalizedstring | Order ID |
<category> | ||
| id | normalizedstring | Category ID |
<affiliate> | ||
<commission> | decimal | Publisher commission |
| currency | normalizedstring | Currency of the publisher commission |
<product> | ||
| number | normalizedstring | Product number |
| quantity | short | Product quantity |
<name> | normalizedstring | Product name |
<price> | decimal | Product price |
| currency | normalizedstring | Currency of the product price |
<commission> | ||
| fix | decimal | Fixed commission in the program currency |
| percent | decimal | Variable commission in percent |
Resource Information
| Rate Limited? | No |
| Requests per rate limit window | N/A |
| Authentication | Requires Authentication |
| Response Formats | xml |
| Resource family | basketdata |
| Response Object | basket |
| API Version | 3.0.1.1 |
If the value for <historyid>