/
Retrieve order reactivati...

Retrieve order reactivations
Experimental

Request

Retrieves a list of order reactivations.

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/order-reactivations?limit=1000&offset=1000&filter=string&sort=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of order reactivations retrieved.

Headers
Pagination-Totalinteger

Total number of items.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only

ID of the reactivation.

Example:"ord_rct_0YVJ62AF5XCFCA6EBFAAA3Z7E0"
orderIdstring, <= 50 charactersrequired

ID of the reactivated order.

Example:"ord_01HRF27SATGE4Z6PBJE6PD8328"
cancellationIdstring, <= 50 charactersread-only

ID of the related cancellation.

Example:"sub_cnl_0YVJ5XVQM9CDP8248ZQX0RDMKV"
descriptionstring or null, <= 255 characters

Description of the reactivation reason in free form.

renewalTimestring, (date-time)

Date and time of the next order renewal. If this field is omitted, this value is computed from the effectiveTime field.

If the order is canceled but still active, it is ignored and the next renewal occurs as scheduled.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

]
Response
[
  {
    "id": "ord_rct_0YVJ62AF5XCFCA6EBFAAA3Z7E0",
    "orderId": "ord_01HRF27SATGE4Z6PBJE6PD8328",
    "cancellationId": "sub_cnl_0YVJ5XVQM9CDP8248ZQX0RDMKV",
    "description": "string",
    "renewalTime": "2019-08-24T14:15:22Z",
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ]
  }
]