order

order.info

Info about a specific order by ID

get/order.info.json

Request

  • Base URL: https://api.api2cart.com/v1.1
  • URL: https://api.api2cart.com/v1.1/order.info.json
  • Auth: API key in header x-api-key and API key in header x-store-key

Query parameters

idstring

Retrieves order info specified by id

order_idstring

Retrieves order’s info specified by order id

store_idstring

Defines store id where the order should be found

paramsstring

Important! Parameter deprecated, use response_fields instead. Set this parameter in order to choose which entity fields you want to retrieve

response_fieldsstring

Set this parameter to choose which entity fields to retrieve. Use comma-separated field names in curly braces, nested to match the response structure, e.g. {result{product{id,name}}}. The wildcard * returns every field at a level: {} gives the whole response, {result{product{}}} all product fields.

excludestring

Important! Parameter deprecated, use response_fields instead. Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter params equal force_all

enable_cacheboolean

If the value is 'true' and order exist in our cache, we will return order.info response from cache

use_latest_api_versionboolean

Use the latest platform API version

rounding_precisioninteger
<p>Specifies the rounding precision for fractional numeric values (such as prices, taxes, and weights).</p> <p>Supported values range from <b>1</b> to <b>6</b>.</p> <p>The default rounding precision may vary depending on the platform. You can retrieve the default value using the <strong>cart.info</strong> method in the <code>default_rounding_precision</code> field. </p><p>Values are rounded to the nearest number at the specified precision. Fractions of .5 or higher are rounded up, while fractions lower than .5 are rounded down.</p>
allow_user_defined_order_statusesboolean

Indicates whether custom (user-defined) order statuses should be included in the response.

Response

successful operation

return_codeinteger
return_messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.