/
Retrieve an attachment

Retrieve an attachment

Request

Retrieves an attachment with a specified ID.

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

ID of the resource.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/attachments/{id}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Attachment retrieved.

Bodyapplication/json
idstring, <= 50 charactersread-only

ID of the attachment.

Example:"att_0YV7J787J0DW0918MQQMDHWA7M"
fileIdstring, <= 50 charactersrequired

ID of the linked file object.

Example:"file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"
relatedTypestringrequired

Linked object type.

Enum:"credit-memo-timeline-comment""customer""customer-timeline-comment""dispute""gateway-timeline-comment""invoice""invoice-timeline-comment""order-timeline-comment""organization""payment"
relatedIdstringrequired

ID of the linked object.

namestring

Name of original attachment.

descriptionstring

Description of the attachment.

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.

_embeddedobjectread-only

Embedded objects that are requested by the expand query parameter.

Response
{
  "id": "att_0YV7J787J0DW0918MQQMDHWA7M",
  "fileId": "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N",
  "relatedType": "credit-memo-timeline-comment",
  "relatedId": "string",
  "name": "string",
  "description": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ],
  "_embedded": {
    "file": {}
  }
}