Inbound Order Documents

Endpoints related to Inbound Order Documents.

List documents

GET

https://api.cartoncloud.com

/tenants/{tenantId}/inbound-orders/{orderId}/documents

required permission: VIEW_DOCUMENT

List documents attached to an inbound order

List documents › path Parameters

tenantId

string · uuid · required

Tenant ID. Can be found in organisation settings

orderId

string · uuid · required

Inbound Order ID

List documents › query Parameters

page

integer

The page number to return results for

size

integer

The number of elements per page. Default value may vary between endpoints

List documents › 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:

List documents › Responses

Success

InboundOrderDocument[]

InboundOrderDocument

object · required

type

string · enum · required

Enum values:

INBOUND_RECEIVAL

id

string · uuid · readOnly

status

string · enum · readOnly

Enum values:

CREATED_PENDING

UPDATED_PENDING

ACTIVE

INACTIVE

ERROR

Default: CREATED_PENDING

object

name

string

description

string | null

DocumentDetails | null

Attachment list for this document, or null when none is present.

AuditInfo · readOnly

GET/tenants/{tenantId}/inbound-orders/{orderId}/documents

curl https://api.cartoncloud.com/tenants/:tenantId/inbound-orders/:orderId/documents \
  --header 'Accept-Version: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "id": "6812161f-69d9-48f4-b873-0ff0f00f0413",
    "status": "CREATED_PENDING",
    "access": {
      "view": "INTERNAL",
      "edit": "INTERNAL"
    },
    "owner": {
      "type": "type",
      "id": "952e750b-d9f3-41ab-b536-23b6fef51577"
    },
    "name": "name",
    "description": "description",
    "details": {
      "attachments": [
        {
          "id": "ed9189c2-9ff9-48bf-9733-2795d79d6d98",
          "contentMd5": "grtjxksghlxwli02qzGHZA==",
          "contentType": "image/jpeg",
          "name": "photo1.jpg",
          "uploadUrl": "https://s3.amazonaws.com/bucket/21119274-ff7f-4f11-84ce-4a91261630d1/photo1.jpg",
          "downloadUrl": "https://s3.amazonaws.com/bucket/70bdbf45-b2cc-4808-b7ad-bc9d226fb72a/photo1.jpg",
          "sizeInBytes": 1024,
          "meta": {
            "created": "2024-08-25T15:00:00Z",
            "latitude": "34.390833",
            "longitude": "132.452500"
          },
          "exists": false
        }
      ]
    },
    "auditInfo": {
      "createdBy": "598fe9e4-4eca-4865-8bb7-720855ea6a69",
      "createdTime": "2024-08-25T15:00:00Z",
      "lastModifiedBy": "50589c92-a3ea-4fc2-8d77-22fe1c0f7100",
      "lastModifiedTime": "2024-08-25T15:00:00Z"
    },
    "type": "INBOUND_RECEIVAL"
  }
]

json

application/json

Create document

POST

https://api.cartoncloud.com

/tenants/{tenantId}/inbound-orders/{orderId}/documents

required permission: EDIT_DOCUMENT

Create a document attached to an inbound order. Create responses include presigned attachment upload and download URLs.

Create document › path Parameters

tenantId

string · uuid · required

Tenant ID. Can be found in organisation settings

orderId

string · uuid · required

Inbound Order ID

Create 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:

External-Meta-Key

string

The External-Meta-Key header allows to specify the desired external meta key and only data associated with the specified key will be returned. If no key is specified or the key does not contain data, then externalMeta will not be returned.

Users with VIEW_ALL_EXTERNAL_META permission can specify * to return all available external meta. Data in externalMeta will be keyed by the external meta key.

Create document › Request Body

InboundOrderDocumentRequest

object

name

string

description

string | null

DocumentRequestDetails | null

Send an object with attachments to request presigned upload URLs, or null if there are no files.

type

string · enum

Enum values:

INBOUND_RECEIVAL

Create document › Responses

Document created. Returns newly created document.

InboundOrderDocument

object · required

type

string · enum · required

Enum values:

INBOUND_RECEIVAL

id

string · uuid · readOnly

status

string · enum · readOnly

Enum values:

CREATED_PENDING

UPDATED_PENDING

ACTIVE

INACTIVE

ERROR

Default: CREATED_PENDING

object

name

string

description

string | null

DocumentDetails | null

Attachment list for this document, or null when none is present.

AuditInfo · readOnly

POST/tenants/{tenantId}/inbound-orders/{orderId}/documents

curl https://api.cartoncloud.com/tenants/:tenantId/inbound-orders/:orderId/documents \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept-Version: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "type": "INBOUND_RECEIVAL",
  "access": {
    "view": "INTERNAL"
  },
  "name": "Receival Photo",
  "description": "Photos of stock after unloading truck",
  "details": {
    "attachments": [
      {
        "id": "5568a62c-d367-4f33-870f-d1a2c1352253",
        "name": "receival-photo.png",
        "contentType": "image/png",
        "sizeInBytes": 38605,
        "contentMd5": "grtjxksghlxwli02qzGHZA=="
      }
    ]
  }
}'

Example Request Body

{
  "type": "INBOUND_RECEIVAL",
  "access": {
    "view": "INTERNAL"
  },
  "name": "Receival Photo",
  "description": "Photos of stock after unloading truck",
  "details": {
    "attachments": [
      {
        "id": "5568a62c-d367-4f33-870f-d1a2c1352253",
        "name": "receival-photo.png",
        "contentType": "image/png",
        "sizeInBytes": 38605,
        "contentMd5": "grtjxksghlxwli02qzGHZA=="
      }
    ]
  }
}

json

application/json

Example Responses

{
  "id": "e9ab834c-627f-4186-895b-4f0c43c02b52",
  "type": "INBOUND_RECEIVAL",
  "status": "CREATED_PENDING",
  "access": {
    "view": "INTERNAL",
    "edit": "INTERNAL"
  },
  "owner": {
    "type": "INBOUND",
    "id": "53aa6ea3-0dd4-4d45-980e-6b9f41fd1ccb"
  },
  "name": "Receival Photo",
  "description": "Photos of stock after unloading truck",
  "details": {
    "attachments": [
      {
        "id": "5568a62c-d367-4f33-870f-d1a2c1352253",
        "name": "receival-photo.png",
        "contentType": "image/png",
        "sizeInBytes": 38605,
        "contentMd5": "grtjxksghlxwli02qzGHZA==",
        "exists": false,
        "uploadUrl": "https://cartoncloud-tenants-files-prod.s3.ap-southeast-2.amazonaws.com/tenant/documents/5568a62c-d367-4f33-870f-d1a2c1352253/receival-photo.png?X-Amz-Signature=upload",
        "downloadUrl": "https://cartoncloud-tenants-files-prod.s3.ap-southeast-2.amazonaws.com/tenant/documents/5568a62c-d367-4f33-870f-d1a2c1352253/receival-photo.png?X-Amz-Signature=download"
      }
    ]
  }
}

json

application/json

Get document

GET

https://api.cartoncloud.com

/tenants/{tenantId}/inbound-orders/{orderId}/documents/{documentId}

required permission: VIEW_DOCUMENT

Get a document attached to an inbound order. Responses include presigned attachment download URLs.

Get document › path Parameters

tenantId

string · uuid · required

Tenant ID. Can be found in organisation settings

orderId

string · uuid · required

Inbound Order ID

documentId

string · uuid · required

Document ID

Get 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:

External-Meta-Key

string

Users with VIEW_ALL_EXTERNAL_META permission can specify * to return all available external meta. Data in externalMeta will be keyed by the external meta key.

Get document › Responses

Document found. Returns document.

InboundOrderDocument

object · required

type

string · enum · required

Enum values:

INBOUND_RECEIVAL

id

string · uuid · readOnly

status

string · enum · readOnly

Enum values:

CREATED_PENDING

UPDATED_PENDING

ACTIVE

INACTIVE

ERROR

Default: CREATED_PENDING

object

name

string

description

string | null

DocumentDetails | null

Attachment list for this document, or null when none is present.

AuditInfo · readOnly

GET/tenants/{tenantId}/inbound-orders/{orderId}/documents/{documentId}

curl https://api.cartoncloud.com/tenants/:tenantId/inbound-orders/:orderId/documents/:documentId \
  --header 'Accept-Version: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "6812161f-69d9-48f4-b873-0ff0f00f0413",
  "status": "CREATED_PENDING",
  "access": {
    "view": "INTERNAL",
    "edit": "INTERNAL"
  },
  "owner": {
    "type": "type",
    "id": "952e750b-d9f3-41ab-b536-23b6fef51577"
  },
  "name": "name",
  "description": "description",
  "details": {
    "attachments": [
      {
        "id": "ed9189c2-9ff9-48bf-9733-2795d79d6d98",
        "contentMd5": "grtjxksghlxwli02qzGHZA==",
        "contentType": "image/jpeg",
        "name": "photo1.jpg",
        "uploadUrl": "https://s3.amazonaws.com/bucket/21119274-ff7f-4f11-84ce-4a91261630d1/photo1.jpg",
        "downloadUrl": "https://s3.amazonaws.com/bucket/70bdbf45-b2cc-4808-b7ad-bc9d226fb72a/photo1.jpg",
        "sizeInBytes": 1024,
        "meta": {
          "created": "2024-08-25T15:00:00Z",
          "latitude": "34.390833",
          "longitude": "132.452500"
        },
        "exists": false
      }
    ]
  },
  "auditInfo": {
    "createdBy": "598fe9e4-4eca-4865-8bb7-720855ea6a69",
    "createdTime": "2024-08-25T15:00:00Z",
    "lastModifiedBy": "50589c92-a3ea-4fc2-8d77-22fe1c0f7100",
    "lastModifiedTime": "2024-08-25T15:00:00Z"
  },
  "type": "INBOUND_RECEIVAL"
}

json

application/json

Update document

PUT

https://api.cartoncloud.com

/tenants/{tenantId}/inbound-orders/{orderId}/documents/{documentId}

required permission: EDIT_DOCUMENT

Update a document attached to an inbound order

Update document › path Parameters

tenantId

string · uuid · required

Tenant ID. Can be found in organisation settings

orderId

string · uuid · required

Inbound Order ID

documentId

string · uuid · required

Document ID

Update 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:

If-Match

string

The If-Match header is used for optimistic concurrency control. It should contain the ETag value of the resource being updated. If the ETag doesn't match the current resource state, the request will be rejected.

Update document › Request Body

InboundOrderDocumentRequest

object

name

string

description

string | null

DocumentRequestDetails | null

Send an object with attachments to request presigned upload URLs, or null if there are no files.

type

string · enum

Enum values:

INBOUND_RECEIVAL

Update document › Responses

Document updated

InboundOrderDocument

object · required

type

string · enum · required

Enum values:

INBOUND_RECEIVAL

id

string · uuid · readOnly

status

string · enum · readOnly

Enum values:

CREATED_PENDING

UPDATED_PENDING

ACTIVE

INACTIVE

ERROR

Default: CREATED_PENDING

object

name

string

description

string | null

DocumentDetails | null

Attachment list for this document, or null when none is present.

AuditInfo · readOnly

PUT/tenants/{tenantId}/inbound-orders/{orderId}/documents/{documentId}

curl https://api.cartoncloud.com/tenants/:tenantId/inbound-orders/:orderId/documents/:documentId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Accept-Version: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "access": {
    "view": "INTERNAL"
  },
  "name": "name",
  "description": "description",
  "details": {
    "attachments": [
      {
        "id": "5568a62c-d367-4f33-870f-d1a2c1352253",
        "name": "Logo-With-Text-Stacked.png",
        "contentType": "image/png",
        "sizeInBytes": 38605,
        "contentMd5": "grtjxksghlxwli02qzGHZA=="
      },
      {
        "id": "74a1a0b4-6a77-4f2d-88f5-ce6b81816ce8",
        "name": "logo-square-1024.jpg",
        "contentType": "image/jpeg",
        "sizeInBytes": 88212,
        "contentMd5": "zZSOWanVo2uJfYnCWVE18w=="
      },
      {
        "id": "16e30dae-17b7-4272-a274-3e9816f9d8ce",
        "name": "logo-square.png",
        "contentType": "image/png",
        "sizeInBytes": 189300,
        "contentMd5": "60b+KOjcC+5DyOwU9BH0Mw=="
      }
    ]
  },
  "type": "INBOUND_RECEIVAL"
}'

Example Request Body

{
  "access": {
    "view": "INTERNAL"
  },
  "name": "name",
  "description": "description",
  "details": {
    "attachments": [
      {
        "id": "5568a62c-d367-4f33-870f-d1a2c1352253",
        "name": "Logo-With-Text-Stacked.png",
        "contentType": "image/png",
        "sizeInBytes": 38605,
        "contentMd5": "grtjxksghlxwli02qzGHZA=="
      },
      {
        "id": "74a1a0b4-6a77-4f2d-88f5-ce6b81816ce8",
        "name": "logo-square-1024.jpg",
        "contentType": "image/jpeg",
        "sizeInBytes": 88212,
        "contentMd5": "zZSOWanVo2uJfYnCWVE18w=="
      },
      {
        "id": "16e30dae-17b7-4272-a274-3e9816f9d8ce",
        "name": "logo-square.png",
        "contentType": "image/png",
        "sizeInBytes": 189300,
        "contentMd5": "60b+KOjcC+5DyOwU9BH0Mw=="
      }
    ]
  },
  "type": "INBOUND_RECEIVAL"
}

json

Example Responses

{
  "id": "6812161f-69d9-48f4-b873-0ff0f00f0413",
  "status": "CREATED_PENDING",
  "access": {
    "view": "INTERNAL",
    "edit": "INTERNAL"
  },
  "owner": {
    "type": "type",
    "id": "952e750b-d9f3-41ab-b536-23b6fef51577"
  },
  "name": "name",
  "description": "description",
  "details": {
    "attachments": [
      {
        "id": "ed9189c2-9ff9-48bf-9733-2795d79d6d98",
        "contentMd5": "grtjxksghlxwli02qzGHZA==",
        "contentType": "image/jpeg",
        "name": "photo1.jpg",
        "uploadUrl": "https://s3.amazonaws.com/bucket/21119274-ff7f-4f11-84ce-4a91261630d1/photo1.jpg",
        "downloadUrl": "https://s3.amazonaws.com/bucket/70bdbf45-b2cc-4808-b7ad-bc9d226fb72a/photo1.jpg",
        "sizeInBytes": 1024,
        "meta": {
          "created": "2024-08-25T15:00:00Z",
          "latitude": "34.390833",
          "longitude": "132.452500"
        },
        "exists": false
      }
    ]
  },
  "auditInfo": {
    "createdBy": "598fe9e4-4eca-4865-8bb7-720855ea6a69",
    "createdTime": "2024-08-25T15:00:00Z",
    "lastModifiedBy": "50589c92-a3ea-4fc2-8d77-22fe1c0f7100",
    "lastModifiedTime": "2024-08-25T15:00:00Z"
  },
  "type": "INBOUND_RECEIVAL"
}

json

application/json

Delete document

DELETE

https://api.cartoncloud.com

/tenants/{tenantId}/inbound-orders/{orderId}/documents/{documentId}

required permission: EDIT_DOCUMENT

Permanently delete a document attached to an inbound order.

Delete document › path Parameters

tenantId

string · uuid · required

Tenant ID. Can be found in organisation settings

orderId

string · uuid · required

Inbound Order ID

documentId

string · uuid · required

Document ID

Delete 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:

Delete document › Responses

Document deleted

No data returned

Get inbound order document history

GET

https://api.cartoncloud.com

/tenants/{tenantId}/inbound-orders/{orderId}/documents/{documentId}/history

required permission: VIEW_DOCUMENT

Returns the audit history for an inbound order document.

Get inbound order document history › path Parameters

tenantId

string · uuid · required

Tenant ID. Can be found in organisation settings

orderId

string · uuid · required

Inbound Order ID

documentId

string · uuid · required

Document ID

Get inbound order document history › 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:

Get inbound order document history › Responses

Success

AuditEvent[]

Audit trail entry for a document or entity.

AuditEvent

id

UUID · uuid

eventTime

string · date-time

Time the event occurred.

UserReference

Identifies a user by id and display name.

action

string

Action that caused the change.

entityType

string

Entity type the event relates to.

entityId

UUID · uuid

object

Snapshot of entity data at the time of the event.

object

Additional context about the change.

Restore document

POST

https://api.cartoncloud.com

/tenants/{tenantId}/inbound-orders/{orderId}/documents/{documentId}/restore

required permission: EDIT_DOCUMENT

Restore a trashed document attached to an inbound order. Sets document status to either 'ACTIVE' or 'UPDATED_PENDING' depending on the state of its associated attachments.

Restore document › path Parameters

tenantId

string · uuid · required

Tenant ID. Can be found in organisation settings

orderId

string · uuid · required

Inbound Order ID

documentId

string · uuid · required

Document ID

Restore 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:

If-Match

string

Restore document › Responses

Document restored. Returns updated document.

object · required

type

string · enum · required

Enum values:

INBOUND_RECEIVAL

id

string · uuid · readOnly

status

string · enum · readOnly

Enum values:

CREATED_PENDING

UPDATED_PENDING

ACTIVE

INACTIVE

ERROR

Default: CREATED_PENDING

object

name

string

description

string | null

DocumentDetails | null

Attachment list for this document, or null when none is present.

AuditInfo · readOnly

POST/tenants/{tenantId}/inbound-orders/{orderId}/documents/{documentId}/restore

curl https://api.cartoncloud.com/tenants/:tenantId/inbound-orders/:orderId/documents/:documentId/restore \
  --request POST \
  --header 'Accept-Version: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "6812161f-69d9-48f4-b873-0ff0f00f0413",
  "status": "CREATED_PENDING",
  "access": {
    "view": "INTERNAL",
    "edit": "INTERNAL"
  },
  "owner": {
    "type": "type",
    "id": "952e750b-d9f3-41ab-b536-23b6fef51577"
  },
  "name": "name",
  "description": "description",
  "details": {
    "attachments": [
      {
        "id": "ed9189c2-9ff9-48bf-9733-2795d79d6d98",
        "contentMd5": "grtjxksghlxwli02qzGHZA==",
        "contentType": "image/jpeg",
        "name": "photo1.jpg",
        "uploadUrl": "https://s3.amazonaws.com/bucket/21119274-ff7f-4f11-84ce-4a91261630d1/photo1.jpg",
        "downloadUrl": "https://s3.amazonaws.com/bucket/70bdbf45-b2cc-4808-b7ad-bc9d226fb72a/photo1.jpg",
        "sizeInBytes": 1024,
        "meta": {
          "created": "2024-08-25T15:00:00Z",
          "latitude": "34.390833",
          "longitude": "132.452500"
        },
        "exists": false
      }
    ]
  },
  "auditInfo": {
    "createdBy": "598fe9e4-4eca-4865-8bb7-720855ea6a69",
    "createdTime": "2024-08-25T15:00:00Z",
    "lastModifiedBy": "50589c92-a3ea-4fc2-8d77-22fe1c0f7100",
    "lastModifiedTime": "2024-08-25T15:00:00Z"
  },
  "type": "INBOUND_RECEIVAL"
}

json

application/json

Trash document

POST

https://api.cartoncloud.com

/tenants/{tenantId}/inbound-orders/{orderId}/documents/{documentId}/trash

required permission: EDIT_DOCUMENT

Trash a document attached to an inbound order. Sets document status to 'INACTIVE'.

Trash document › path Parameters

tenantId

string · uuid · required

Tenant ID. Can be found in organisation settings

orderId

string · uuid · required

Inbound Order ID

documentId

string · uuid · required

Document ID

Trash 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:

If-Match

string

Trash document › Responses

Document trashed. Returns updated document.

object · required

type

string · enum · required

Enum values:

INBOUND_RECEIVAL

id

string · uuid · readOnly

status

string · enum · readOnly

Enum values:

CREATED_PENDING

UPDATED_PENDING

ACTIVE

INACTIVE

ERROR

Default: CREATED_PENDING

object

name

string

description

string | null

DocumentDetails | null

Attachment list for this document, or null when none is present.

AuditInfo · readOnly

POST/tenants/{tenantId}/inbound-orders/{orderId}/documents/{documentId}/trash

curl https://api.cartoncloud.com/tenants/:tenantId/inbound-orders/:orderId/documents/:documentId/trash \
  --request POST \
  --header 'Accept-Version: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "6812161f-69d9-48f4-b873-0ff0f00f0413",
  "status": "CREATED_PENDING",
  "access": {
    "view": "INTERNAL",
    "edit": "INTERNAL"
  },
  "owner": {
    "type": "type",
    "id": "952e750b-d9f3-41ab-b536-23b6fef51577"
  },
  "name": "name",
  "description": "description",
  "details": {
    "attachments": [
      {
        "id": "ed9189c2-9ff9-48bf-9733-2795d79d6d98",
        "contentMd5": "grtjxksghlxwli02qzGHZA==",
        "contentType": "image/jpeg",
        "name": "photo1.jpg",
        "uploadUrl": "https://s3.amazonaws.com/bucket/21119274-ff7f-4f11-84ce-4a91261630d1/photo1.jpg",
        "downloadUrl": "https://s3.amazonaws.com/bucket/70bdbf45-b2cc-4808-b7ad-bc9d226fb72a/photo1.jpg",
        "sizeInBytes": 1024,
        "meta": {
          "created": "2024-08-25T15:00:00Z",
          "latitude": "34.390833",
          "longitude": "132.452500"
        },
        "exists": false
      }
    ]
  },
  "auditInfo": {
    "createdBy": "598fe9e4-4eca-4865-8bb7-720855ea6a69",
    "createdTime": "2024-08-25T15:00:00Z",
    "lastModifiedBy": "50589c92-a3ea-4fc2-8d77-22fe1c0f7100",
    "lastModifiedTime": "2024-08-25T15:00:00Z"
  },
  "type": "INBOUND_RECEIVAL"
}

json

application/json

Drivers Inbound Order Items