shop.order.search

Performs order search.

Parameters

  • hash GET Optional

    Hash string to create an order collection, used in shopOrdersCollection class.

  • offset GET Optional

    Offset relative to the beginning of the list of found orders. Non-negative integer, max. 1000. Default value: 0.

  • limit GET Optional

    Limit on the number of found orders. Non-negative integer. Default value: 100.

  • access_token GET

    API auth token obtained during the API authorization.

  • format GET Optional

    Sets response format. Available options: json (default), xml.

Example

https://demo1.webasyst.com/api.php/shop.order.search?

Error codes

  • invalid_request

    Invalid formed request. Additional information about the error is available in error_description parameter.

  • access_denied

    Access to the specified API method for the current token is denied.

  • invalid_method

    Unknown API method.