Documents

Server

Legacy tenant collection for creating a document attached to an owner.

Create tenant document

POST

https://api.cartoncloud.com

/tenants/{tenantId}/documents

Create a document and attach it to an object in the system (owner).

This is the legacy tenant collection endpoint. Inbound, outbound, and consignment document APIs are separate resources.

API clients with Customer-role access can upload only when the customer is allowed to upload documents (Customer Invoice or Document Upload in customer warehouse management settings).

Create tenant document › path Parameters

tenantId

string · uuid · required

Tenant ID. Can be found in organisation settings

Create tenant document › Headers

Accept-Version

string · enum · required

All API end points require Accept-Version in the request header.

Failure to provide the header will return a status code of 400, however, an invalid version can return a 404, 406 or 400.

Enum values:

Create tenant document › Request Body

Legacy request to create a document and attach it to an owner via POST /tenants/{tenantId}/documents.

TenantDocumentRequest

type

string · enum · required

Document type code. OUTBOUND_ORDER_INVOICE applies to owner type OUTBOUND.

Enum values:

OUTBOUND_ORDER_INVOICE

object · required

Create tenant document › Responses

Created

Legacy tenant-collection document (Accept-Version 1). Distinct from inbound, outbound, and consignment document resources.

TenantDocument

type

string · enum · required

Enum values:

OUTBOUND_ORDER_INVOICE

object · required

id

string · uuid · readOnly

object

POST/tenants/{tenantId}/documents

curl https://api.cartoncloud.com/tenants/:tenantId/documents \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept-Version: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "type": "OUTBOUND_ORDER_INVOICE",
  "owner": {
    "type": "OUTBOUND",
    "id": "fb5b56f6-a68e-4168-a5d0-52929abc1459"
  },
  "content": {
    "name": "Invoice.pdf",
    "data": "JVBERi0xLjcKJeLjz9MKNSdCAzOCAwIFIKL0"
  }
}'

Example Request Body

{
  "type": "OUTBOUND_ORDER_INVOICE",
  "owner": {
    "type": "OUTBOUND",
    "id": "fb5b56f6-a68e-4168-a5d0-52929abc1459"
  },
  "content": {
    "name": "Invoice.pdf",
    "data": "JVBERi0xLjcKJeLjz9MKNSdCAzOCAwIFIKL0"
  }
}

json

application/json

Example Responses

{
  "id": "975487fb-833d-41de-9ac2-114d8e6cb9e2",
  "type": "OUTBOUND_ORDER_INVOICE",
  "owner": {
    "type": "OUTBOUND",
    "id": "2df05c03-8f11-4cba-b78d-7a6f34d34c8b"
  },
  "content": {
    "name": "Invoice.pdf"
  }
}

json

application/json

Customers Inbound Orders (Purchase Orders)

CartonCloud API

Documents

Server

Legacy tenant collection for creating a document attached to an owner.

Create tenant document

POST

https://api.cartoncloud.com

/tenants/{tenantId}/documents

Create a document and attach it to an object in the system (owner).

This is the legacy tenant collection endpoint. Inbound, outbound, and consignment document APIs are separate resources.

API clients with Customer-role access can upload only when the customer is allowed to upload documents (Customer Invoice or Document Upload in customer warehouse management settings).

Create tenant document › path Parameters

tenantId

string · uuid · required

Tenant ID. Can be found in organisation settings

Create tenant document › Headers

Accept-Version

string · enum · required

All API end points require Accept-Version in the request header.

Failure to provide the header will return a status code of 400, however, an invalid version can return a 404, 406 or 400.

Enum values:

Create tenant document › Request Body

Legacy request to create a document and attach it to an owner via POST /tenants/{tenantId}/documents.

TenantDocumentRequest

type

string · enum · required

Document type code. OUTBOUND_ORDER_INVOICE applies to owner type OUTBOUND.

Enum values:

OUTBOUND_ORDER_INVOICE

object · required

Create tenant document › Responses

Created

Legacy tenant-collection document (Accept-Version 1). Distinct from inbound, outbound, and consignment document resources.

TenantDocument

type

string · enum · required

Enum values:

OUTBOUND_ORDER_INVOICE

object · required

id

string · uuid · readOnly

object

POST/tenants/{tenantId}/documents

curl https://api.cartoncloud.com/tenants/:tenantId/documents \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept-Version: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "type": "OUTBOUND_ORDER_INVOICE",
  "owner": {
    "type": "OUTBOUND",
    "id": "fb5b56f6-a68e-4168-a5d0-52929abc1459"
  },
  "content": {
    "name": "Invoice.pdf",
    "data": "JVBERi0xLjcKJeLjz9MKNSdCAzOCAwIFIKL0"
  }
}'

Example Request Body

{
  "type": "OUTBOUND_ORDER_INVOICE",
  "owner": {
    "type": "OUTBOUND",
    "id": "fb5b56f6-a68e-4168-a5d0-52929abc1459"
  },
  "content": {
    "name": "Invoice.pdf",
    "data": "JVBERi0xLjcKJeLjz9MKNSdCAzOCAwIFIKL0"
  }
}

json

application/json

Example Responses

{
  "id": "975487fb-833d-41de-9ac2-114d8e6cb9e2",
  "type": "OUTBOUND_ORDER_INVOICE",
  "owner": {
    "type": "OUTBOUND",
    "id": "2df05c03-8f11-4cba-b78d-7a6f34d34c8b"
  },
  "content": {
    "name": "Invoice.pdf"
  }
}

json

application/json

Customers Inbound Orders (Purchase Orders)