Requests Attachments

Attachment object

The definition represents an Attachment object in Marketplace. This Attachment object inherits from the abstract File base object.

Fields

Field	Type	Description
inlineAttachmentContent	string	Inline attachment content. For example, in the case of type LicenseKey, this field is actually populated with a license key string. Example: "DFE25-GQ943-GH992-KL235-PY037"

Specific field behavior

Field	Description
id	Primary attachment identifier using the prefix “ATT”. Example: "ATT-1234-1234-1234"
classification	File or License Key Example: "File"
status	Attachment status. Can be Published or Deleted. Example: "Published"

Example

REQUEST ATTACHMENTS OBJECT

{
  "id": "ATT-1234-1234-1234",
  "name": "Some order attachment",
  "href": "/commerce/orders/ORD-2119-4550/attachment/ATT-1234-1234-1234",
  "classification": "Text",
  "contentType": "application/x-iso9660-image",
  "size": 123,
  "description": "Some order attachment description",
  "filename": "SomeOrderAttachment.txt",
  "inlineAttachmentContent": null,
  "audit": {
    "created": {
      "at": "2023-01-01T22:00:00Z",
      "by": { ... }
    }
  }
}