OrderResult Document (Shop API 15.1)

Result document of orders.

Property Type Constraints Description
count Integer   The number of returned documents.
data [Order]   The array of customer address documents.
from DateTime   The order search from date. This property follows the ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ. The time zone of the date time is always UTC.
next String   The URL of the next result page.
previous String   The URL of the previous result page.
start Integer minIntegerValue=0 The zero-based index of the first search hit to include in the result.
status Enum {created, new, open, completed, cancelled, replaced, failed}   The order search status specified in request.
total Integer   The total number of documents.
until DateTime   The order search until date. This property follows the ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ. The time zone of the date time is always UTC.
OCAPI obsolete versions 13.x and 14.x will be end of life in 2020 and versions 15.x and 16.x in 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.