| Item | Data type | Required | Meaning |
| Global parameters |
| AfterbuyGlobal | Container | Y | Container with credentials |
| ...PartnerToken | String | Y/N | Afterbuy partner token |
| ...AccountToken | String | Y/N | Afterbuy account token |
| ...CallName | String | Y | Action |
| ...DetailLevel | String | Y | Restrictions of the data |
| ...ErrorLanguage | String | Y | Country identification for error messages and warnings |
| Call-specific parameters |
| RequestAllItems | Integer | N | If the option is set, all orders are returned including those without a VorgangsID.
(The VorgangsID is set when the feedback date of the transaction is set). If filter 'RangeID' with 'ValueFrom' is used, no items without VorgangsID will be returned. The 'FilterValue' tag in the 'OrderID' filter must be 0 if only items without VorgangsID are to be returned. If no 'RangeID' and 'OrderID' filters are passed, all items with and without VorgangsID will be returned. To ensure correct assignment of orders it is not recommended to use this option. |
| MaxSoldItems | Integer | N | Specifies how many orders are returned per call-off (1 - 250). Default = 250 |
| OrderDirection | Integer | N | Specifies the sorting direction of the results. Default Ascending (ACS), 1 = Descending (DESC).
Note: the sort direction can be used only if MaxSoldItems value is <= 100. If the value is greater the sort direction is set to default.
|
| ReturnHiddenItems | Integer | N | If this option is set (=1), hidden items will also be returned. |
| DataFilter | Container | Y | Container with filters |
| ...Filter | Container | Y | Container with filter data |
| ...Filter.FilterName = 'DateFilter' |
| [...]...FilterValues.DateFrom | Date | Y/N | Start Date |
| [...]...FilterValues.DateTo | Date | Y/N | End Date |
| [...]...FilterValues.FilterValue | String | Y/N | Reference
Possible values:
AuctionEndDate - End time of the order.
FeedbackDate - Feedback date of the order
PayDate - Payment date of the order
ShippingDate - Shipping date of the order
InvoiceDate - Invoice date of the order
ModDate - Modification date of the order
XmlDate - XML export date of the order
MailDate - Mail dispatch date
ReminderDate - Reminder date |
| ...Filter.FilterName = 'OrderID' |
| [...]...FilterValues.FilterValue | Integer | Y | VorgangsID's. If 'RequestAllItems' = 1 the value 0 can be passed here to retrieve all items without a VorgangsID. |
| ...Filter.FilterName = 'Plattform' |
| [...]...FilterValues.FilterValue | String | Y | Internal type. E.g. ebay, amazon, azubo, auvito, gutschrift...
The values can be negated with a preceding "not_" (e.g. "not_ebay").
|
| ...Filter.FilterName = 'RangeID' |
| [...]...FilterValues.ValueFrom | Integer | Y | Greater than VorgangsID (so that LastOrderID can be used directly). |
| [...]...FilterValues.ValueTo | Integer | Y | to VorgangsID |
| ...Filter.FilterName = 'DefaultFilter' |
| [...]...FilterValues.FilterValue | String | Y | Default filter name
Possible values:
NewAuctions - New transactions (No feedback date, No first contact mail sent, No payment date).
ReadyToShip - Ready to ship
CompletedAuctions - Completed transactions (NumberDate set, ShipmentDate set, Complete price is paid)
PaidAuctions - Paid transactions (payment date set, complete price is paid)
InvoicePrinted - transactions with printed invoice
NoXMLDate - Transactions without XML date
The values can be negated with a preceding "not_" (e.g. "not_NewAuctions").
|
| ...Filter.FilterName = 'AfterbuyUserID' |
| [...]...FilterValues.FilterValue | Integer | Y | Afterbuy Buyer IDs |
| ...Filter.FilterName = 'UserDefinedFlag' |
| [...]...FilterValues.FilterValue | Integer | Y | ID of the own seller flag.
The flags can be retrieved with the GetUserDefinedFlags call. |
| ...Filter.FilterName = 'AfterbuyUserEmail' |
| [...]...FilterValues.FilterValue | String | Y | Buyer Email |
| ...Filter.FilterName = 'ShopId' |
| [...]...FilterValues.FilterValue | Integer | Y | Ids of the Afterbuy shops that are available in the account. Sales can be retrieved separately per store.
Max. 5 shops are allowed in the filter.
|
| ...Filter.FilterName = 'Tag' |
| [...]...FilterValues.FilterValue | String | N | Output of the associated tags
|
| ...Filter.FilterName = 'InvoiceNumber' |
| [...]...FilterValues.FilterValue | Integer | N | Output of the transactions with specified invoice numbers. Maximum 10 values allowed.
|
| ...Filter.FilterName = 'AlternativeItemNumber1' |
| [...]...FilterValues.FilterValue | String | N | Output of operations with specified alternative item number 1. Maximum 10 values allowed. Maximum length per value: 50 characters.
|
| ...Filter.FilterName = 'AlternativeItemNumber2' |
| [...]...FilterValues.FilterValue | String | N | Output of operations with specified alternative item number 2. 10 values maximum allowed. Maximum length per value: 20 characters.
|