Credit memos timeline

Use credit memo timelines to maintain an audit trail of changes and activity for each credit memo. Credit memos are a means of providing a customer with store credit.

Operations

Retrieve credit memo timeline messages

Request

Retrieves a list of credit memo timeline messages.

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

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 ,.

qstring

Use this field to perform a partial search of text fields.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/credit-memos/{id}/timeline?limit=1000&offset=1000&filter=string&sort=string&q=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of credit memo timeline messages 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 timeline message.

Example:"tmln_0YV8Q9WEF5DTA8HFXS27D1G6GC"
typestringread-only

Type of timeline message.

Enum:"credit-memo-created""credit-memo-applied""credit-memo-partially-applied""credit-memo-voided"
triggeredBystringread-only

Specifies who, or what, triggered the timeline event.

Enum:"rebilly""app""direct-api"
messagestring

Content of the timeline message.

extraDataobject(TimelineExtraData)read-only

Additional data.

occurredTimestring, (date-time)(ServerTimestamp)read-only

Date and time when the timeline message occurred.

]
Response
[
  {
    "id": "tmln_0YV8Q9WEF5DTA8HFXS27D1G6GC",
    "type": "credit-memo-created",
    "triggeredBy": "rebilly",
    "message": "string",
    "extraData": { … },
    "occurredTime": "2019-08-24T14:15:22Z",
    "_links": [ … ]
  }
]