Allows you to end a list of items.
Header | Data Type | Valid Values | Required | Description |
---|---|---|---|---|
Content-Type | string | application/json | YES | The format your data will be sent to our site. |
X-DevKey | string | string | YES | The devkey assigned to the developer. |
X-AccessToken | string | string | YES | The token acquired from a POST to Users/AccessToken. |
NOTE: Variables to place in the query string of the request.
Parameter | Data Type | Valid Values | Description |
---|---|---|---|
itemIds | string | Comma-separated item ids | List of item ids to return. Ex: itemIds=12345,67890 |
If itemIDs is not provided, you will receive a 400 Bad Request
If one of the itemIDs cannot be parsed into an integer, you will receive a 400 Bad Request
and a message indicating which item ID was invalid.
If the number of itemIDs provided exceeds 100, you will receive a 403 Forbidden
If there are no errors with the input parameters, this call will respond with a 200 OK
and the following data as serialized JSON
Parameter | Data Type | Valid Values | Description |
---|---|---|---|
SuccessfullyEndedItems | Array | Array of successfully ended items (see below) | The list of items that successfully ended |
UnsuccessfullyEndedItems | Array | Array of items that did not end successfully (see below) | The list of items that did not end successfully |
Parameter | Data Type | Valid Values | Description |
---|---|---|---|
ItemID | integer | positive # | The id of the item that ended |
Parameter | Data Type | Valid Values | Description |
---|---|---|---|
ItemID | integer | positive # | The id of the item that failed to end |
ErrorMessage | string | string | The error message for the item that failed to end |