List the attachments of an order

GET

/orders/{orderId}/attachments

const url = 'https://acme.mykreezalid.com/front_api/v1/orders/4242/attachments?page=1&limit=25';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://acme.mykreezalid.com/front_api/v1/orders/4242/attachments?page=1&limit=25' \
  --header 'Authorization: Bearer <token>'

Returns the files attached to an order. The signed-in member must be the customer or the vendor of the order. Results are paged, 25 per page by default; the response carries no paging information.

Authorizations

bearerAuth

Parameters

Path Parameters

orderId

required

integer

Identifier of the order.

Example

Query Parameters

page

integer

default: 1 >= 1

Page to return, starting at 1.

limit

integer

default: 25 >= 1 <= 100

Number of attachments per page.

Responses

200

The attachments of the order.

application/json

object

attachments

Array<object>

A file attached to an order by its customer or its vendor.

object

integer

order_id

integer

createdBy

Identifier of the member who attached the file.

integer

updatedBy

Identifier of the member who last changed the attachment. Returned by the list and read operations only.

integer

nullable

name

Name given to the attachment.

string

nullable

type

string

Allowed values: USER_MANUAL WARRANTY CERTIFICATES DELIVERY_BILL CUSTOMER_INVOICE OTHER

url

Public link to the file.

string format: uri

filename

Name of the stored file.

string

created

string format: date-time

modified

string format: date-time

Example

{
  "attachments": [
    {
      "id": 4242,
      "order_id": 4243,
      "createdBy": 4244,
      "name": "Invoice October",
      "type": "USER_MANUAL",
      "filename": "6526f1a3b2c4d.pdf"
    }
  ]
}

403

No signed-in member, or the signed-in member is neither the customer nor the vendor of the order (or the order does not exist).

application/json

Error body returned by the Front API when it refuses a request.

object

code

HTTP status code, repeated in the body.

integer

status

string

message

Human-readable reason.

string

Example

{
  "code": 403,
  "status": "error",
  "message": "Token not found in request"
}

404

The requested page is beyond the last page.