Shipment, Invoice, Return Downloads

These are limited downloads of key data respective to their data types.

Query Criteria

Order Status

Ignored and not in use.

Number of Records To Pull (Optional)

You can limit the number of records to retrieve on each reader invocation.

Setting this to ‘1’ in conjunction with the Starting increment id can be useful for debugging.

Starting Increment ID

Sets the starting document number for querying Magento.

Setting this is useful for existing Magento instances where ‘old’ documents need to be skipped or ignored from querying.

Custom Header Field List, Custom Detail Field List

Ignored

Store List

Where specified allows you to limit which stores to obtain documents by Magento store id. If empty all stores will be queried, otherwise separate each store_id with a comma.

Starting Created Date, Starting Updated Date

Where specified will limit the credit memos are returned by their created/updated dates respectively.

The date should be in form: yyyy-MM-dd

Returned Data

Document Header

Will include a limited sert of header fields such as totals and ids.

Document Detail

Contains the ‘basic’ set of item data (sku, description, price, taxes, ) for the document line.

Document Comment

Any comments attached to the document.