Get Brack History API
The Get Brack History API request is used to query the brack history.
Filtering terms | Description |
|---|---|
page | The serial number of the page to be queried. |
limit | The number of results per page.
(Maximum 1000/page, above that, one page at a time using page parameter(s).) |
dateFrom | The date created and restored. |
In case of XML:
Request (example):
<request>
<apiKey>LJF7X3OWZdzMaSubHDqhfKC04PTospIA62mtrklj1ReVExGn9B</apiKey>
<page>0</page>
<limit>1000</limit>
<filters>
<dateFrom>2019-03-08 00:00:00</dateFrom>
</filters>
</request>
Response (example):
<?xml version="1.0" encoding="utf-8"?>
<response>
<status>
<![CDATA[success]]>
</status>
<message/>
<result>
<elem>
<id>
<![CDATA[1]]>
</id>
<sku>
<![CDATA[T-SHIRT-SHIP-YOUR-IDEA-BLACK]]>
</sku>
<createdAt>
<![CDATA[2019-03-19 10:45:11]]>
</createdAt>
<status>
<![CDATA[restored]]>
</status>
<quantity>
<![CDATA[1]]>
</quantity>
<description/>
<restoredAt>
<![CDATA[2022-03-01 16:09:49]]>
</restoredAt>
<restoreDescription/>
</elem>
<elem>
<id>
<![CDATA[5]]>
</id>
<sku>
<![CDATA[T-SHIRT-SHIP-YOUR-IDEA-BLACK]]>
</sku>
<createdAt>
<![CDATA[2019-04-04 16:42:21]]>
</createdAt>
<status>
<![CDATA[restored]]>
</status>
<quantity>
<![CDATA[1]]>
</quantity>
<description>
<![CDATA[Róka tesztel]]>
</description>
<restoredAt>
<![CDATA[2022-03-01 16:09:48]]>
</restoredAt>
<restoreDescription/>
</elem>
<elem>
<id>
<![CDATA[8]]>
</id>
<sku>
<![CDATA[T-SHIRT-SHIP-YOUR-IDEA-GREEN]]>
</sku>
<createdAt>
<![CDATA[2019-05-14 14:23:48]]>
</createdAt>
<status>
<![CDATA[restored]]>
</status>
<quantity>
<![CDATA[1]]>
</quantity>
<description>
<![CDATA[Összetört a termék...]]>
</description>
<restoredAt>
<![CDATA[2022-03-08 08:12:29]]>
</restoredAt>
<restoreDescription>
<![CDATA[Mégsem tört el annyira.]]>
</restoreDescription>
</elem>
<elem>
<id>
<![CDATA[9]]>
</id>
<sku>
<![CDATA[T-SHIRT-SHIP-YOUR-IDEA-BLACK]]>
</sku>
<createdAt>
<![CDATA[2019-06-13 13:55:29]]>
</createdAt>
<status>
<![CDATA[bracked]]>
</status>
<quantity>
<![CDATA[1]]>
</quantity>
<description>
<![CDATA[Már nem is tudom]]>
</description>
<restoredAt/>
<restoreDescription/>
</elem>
</result>
</response>
In case of a failed request (example):
<?xml version="1.0" encoding="utf-8"?>
<response>
<status>
<![CDATA[error]]>
</status>
<message>
<elem>
<![CDATA[API key not present]]>
</elem>
</message>
</response>
In case of JSON:
Request (example):
{
"apiKey": "LJF7X3OWZdzMaSubHDqhfKC04PTospIA62mtrklj1ReVExGn9B",
"page": 0,
"limit": 1000,
"filters": {
"dateFrom": "2019-03-08 00:00:00”
}
}
Response (example):
{
"status": "success",
"message": [],
"result": [
{
"id": "1",
"sku": "T-SHIRT-SHIP-YOUR-IDEA-BLACK",
"createdAt": "2019-03-19 10:45:11",
"status": "restored",
"quantity": "1",
"description": "",
"restoredAt": "2022-03-01 16:09:49",
"restoreDescription": null
},
{
"id": "5",
"sku": "T-SHIRT-SHIP-YOUR-IDEA-BLACK",
"createdAt": "2019-04-04 16:42:21",
"status": "restored",
"quantity": "1",
"description": "Róka tesztel",
"restoredAt": "2022-03-01 16:09:48",
"restoreDescription": null
},
{
"id": "8",
"sku": "T-SHIRT-SHIP-YOUR-IDEA-GREEN",
"createdAt": "2019-05-14 14:23:48",
"status": "restored",
"quantity": "1",
"description": "Összetört a termék...",
"restoredAt": "2022-03-08 08:12:29",
"restoreDescription": "Mégsem tört el annyira."
},
{
"id": "9",
"sku": "T-SHIRT-SHIP-YOUR-IDEA-BLACK",
"createdAt": "2019-06-13 13:55:29",
"status": "bracked",
"quantity": "1",
"description": "Már nem is tudom",
"restoredAt": null,
"restoreDescription": null
}
]
}
In case of a failed request (example):
{
"status": "error",
"message": [
"API key not present"
]
}
Last modified 10mo ago