InkCloud API (1.0.0)

Download OpenAPI specification:Download

Documentation of the main Ink Cloud API

accounting

A accounting service

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
filter	object (fulfillment-staging-locations/staged) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/accounting?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

[{ }
]

accounting-integration-logs

A accounting-integration-logs service

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (accountingIntegrationLogs) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/accounting-integration-logs?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"tenant": "string",
"integrationType": "string",
"entityId": "string",
"entityName": "string",
"serviceName": "string",
"method": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"status": "pending",
"errorMessage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
integrationType required	string
entityId	string^[0-9a-fA-F]{24}$ Refers to orders
entityName required	string
serviceName required	string
method required	string
startedAt	string <date-time>
completedAt	string <date-time>
status required	string Default: "pending" Enum: "pending" "in-progress" "complete" "canceled" "failed"
errorMessage	string
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"integrationType": "string",
"entityId": "string",
"entityName": "string",
"serviceName": "string",
"method": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"status": "pending",
"errorMessage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

{"tenant": "string",
"integrationType": "string",
"entityId": "string",
"entityName": "string",
"serviceName": "string",
"method": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"status": "pending",
"errorMessage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of accountingIntegrationLogs to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/accounting-integration-logs/%7B_id%7D

Response samples

200

Content type

application/json

{"tenant": "string",
"integrationType": "string",
"entityId": "string",
"entityName": "string",
"serviceName": "string",
"method": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"status": "pending",
"errorMessage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of accountingIntegrationLogs to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
integrationType required	string
entityId	string^[0-9a-fA-F]{24}$ Refers to orders
entityName required	string
serviceName required	string
method required	string
startedAt	string <date-time>
completedAt	string <date-time>
status required	string Default: "pending" Enum: "pending" "in-progress" "complete" "canceled" "failed"
errorMessage	string
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"integrationType": "string",
"entityId": "string",
"entityName": "string",
"serviceName": "string",
"method": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"status": "pending",
"errorMessage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"integrationType": "string",
"entityId": "string",
"entityName": "string",
"serviceName": "string",
"method": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"status": "pending",
"errorMessage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of accountingIntegrationLogs to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
integrationType required	string
entityId	string^[0-9a-fA-F]{24}$ Refers to orders
entityName required	string
serviceName required	string
method required	string
startedAt	string <date-time>
completedAt	string <date-time>
status required	string Default: "pending" Enum: "pending" "in-progress" "complete" "canceled" "failed"
errorMessage	string
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"tenant": "string",
"integrationType": "string",
"entityId": "string",
"entityName": "string",
"serviceName": "string",
"method": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"status": "pending",
"errorMessage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"integrationType": "string",
"entityId": "string",
"entityName": "string",
"serviceName": "string",
"method": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"status": "pending",
"errorMessage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of accountingIntegrationLogs to remove

Responses

Response samples

200

Content type

application/json

{"tenant": "string",
"integrationType": "string",
"entityId": "string",
"entityName": "string",
"serviceName": "string",
"method": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"status": "pending",
"errorMessage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

activity-log

A activity-log service

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (activityLog) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/activity-log?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"business": "string",
"module": "string",
"action": "string",
"user": "string",
"requestUrl": "string",
"requestName": "string",
"data": "string",
"createdAt": "2019-08-24T14:15:22Z",
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

business required	string^[0-9a-fA-F]{24}$ Refers to tenants
module required	string
action required	string
user	string^[0-9a-fA-F]{24}$ Refers to user
requestUrl	string
requestName	string
data	string
createdAt	string <date-time>
_id	string^[0-9a-fA-F]{24}$
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"business": "string",
"module": "string",
"action": "string",
"user": "string",
"requestUrl": "string",
"requestName": "string",
"data": "string",
"createdAt": "2019-08-24T14:15:22Z",
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

{"business": "string",
"module": "string",
"action": "string",
"user": "string",
"requestUrl": "string",
"requestName": "string",
"data": "string",
"createdAt": "2019-08-24T14:15:22Z",
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of activityLog to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/activity-log/%7B_id%7D

Response samples

200

Content type

application/json

{"business": "string",
"module": "string",
"action": "string",
"user": "string",
"requestUrl": "string",
"requestName": "string",
"data": "string",
"createdAt": "2019-08-24T14:15:22Z",
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of activityLog to update

Request Body schema: application/json

business required	string^[0-9a-fA-F]{24}$ Refers to tenants
module required	string
action required	string
user	string^[0-9a-fA-F]{24}$ Refers to user
requestUrl	string
requestName	string
data	string
createdAt	string <date-time>
_id	string^[0-9a-fA-F]{24}$
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"business": "string",
"module": "string",
"action": "string",
"user": "string",
"requestUrl": "string",
"requestName": "string",
"data": "string",
"createdAt": "2019-08-24T14:15:22Z",
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"business": "string",
"module": "string",
"action": "string",
"user": "string",
"requestUrl": "string",
"requestName": "string",
"data": "string",
"createdAt": "2019-08-24T14:15:22Z",
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of activityLog to update

Request Body schema: application/json

business required	string^[0-9a-fA-F]{24}$ Refers to tenants
module required	string
action required	string
user	string^[0-9a-fA-F]{24}$ Refers to user
requestUrl	string
requestName	string
data	string
createdAt	string <date-time>
_id	string^[0-9a-fA-F]{24}$
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"business": "string",
"module": "string",
"action": "string",
"user": "string",
"requestUrl": "string",
"requestName": "string",
"data": "string",
"createdAt": "2019-08-24T14:15:22Z",
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"business": "string",
"module": "string",
"action": "string",
"user": "string",
"requestUrl": "string",
"requestName": "string",
"data": "string",
"createdAt": "2019-08-24T14:15:22Z",
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of activityLog to remove

Responses

Response samples

200

Content type

application/json

{"business": "string",
"module": "string",
"action": "string",
"user": "string",
"requestUrl": "string",
"requestName": "string",
"data": "string",
"createdAt": "2019-08-24T14:15:22Z",
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

address-book

A address-book service

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (addressBook) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/address-book?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"business": "string",
"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"costCenter": "string",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

business required	string^[0-9a-fA-F]{24}$ Refers to tenants
name required	string
careOf	string
address1 required	string
address2	string
city required	string
stateProvince required	string
postalCode required	string
countryCode	string
phone	string
costCenter	string
deleted	boolean Default: false
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"business": "string",
"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"costCenter": "string",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

{"business": "string",
"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"costCenter": "string",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of addressBook to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/address-book/%7B_id%7D

Response samples

200

Content type

application/json

{"business": "string",
"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"costCenter": "string",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of addressBook to update

Request Body schema: application/json

business required	string^[0-9a-fA-F]{24}$ Refers to tenants
name required	string
careOf	string
address1 required	string
address2	string
city required	string
stateProvince required	string
postalCode required	string
countryCode	string
phone	string
costCenter	string
deleted	boolean Default: false
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"business": "string",
"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"costCenter": "string",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"business": "string",
"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"costCenter": "string",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of addressBook to update

Request Body schema: application/json

business required	string^[0-9a-fA-F]{24}$ Refers to tenants
name required	string
careOf	string
address1 required	string
address2	string
city required	string
stateProvince required	string
postalCode required	string
countryCode	string
phone	string
costCenter	string
deleted	boolean Default: false
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"business": "string",
"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"costCenter": "string",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"business": "string",
"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"costCenter": "string",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of addressBook to remove

Responses

Response samples

200

Content type

application/json

{"business": "string",
"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"costCenter": "string",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

artwork-staged

A artwork-staged service

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (artworkStagedModel) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/artwork-staged?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"tenant": "string",
"microsite": "string",
"customer": "string",
"micrositeUser": "string",
"originalArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0
},
"previewArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0,
"publicUrl": "string"
},
"previewStatus": "awaiting-upload",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

One of

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
customer	string^[0-9a-fA-F]{24}$ Refers to customers
micrositeUser	string^[0-9a-fA-F]{24}$ Refers to micrositeCustomers
	object (originalArtwork)
	object (previewArtwork)
previewStatus	string Default: "pending" Enum: "awaiting-upload" "pending" "in-progress" "complete" "error"
deleted	boolean Default: false
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

Example

artworkStagedModel

{"tenant": "string",
"microsite": "string",
"customer": "string",
"micrositeUser": "string",
"originalArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0
},
"previewArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0,
"publicUrl": "string"
},
"previewStatus": "awaiting-upload",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

Example

artworkStagedModel

{"tenant": "string",
"microsite": "string",
"customer": "string",
"micrositeUser": "string",
"originalArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0
},
"previewArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0,
"publicUrl": "string"
},
"previewStatus": "awaiting-upload",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates multiple resources.

Request Body schema: application/json

Array

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
customer	string^[0-9a-fA-F]{24}$ Refers to customers
micrositeUser	string^[0-9a-fA-F]{24}$ Refers to micrositeCustomers
	object (originalArtwork)
	object (previewArtwork)
previewStatus	string Default: "pending" Enum: "awaiting-upload" "pending" "in-progress" "complete" "error"
deleted	boolean Default: false
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

[{"tenant": "string",
"microsite": "string",
"customer": "string",
"micrositeUser": "string",
"originalArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0
},
"previewArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0,
"publicUrl": "string"
},
"previewStatus": "awaiting-upload",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]

Response samples

200

Content type

application/json

[{"tenant": "string",
"microsite": "string",
"customer": "string",
"micrositeUser": "string",
"originalArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0
},
"previewArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0,
"publicUrl": "string"
},
"previewStatus": "awaiting-upload",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]

Updates multiple resources queried by given filter

Updates multiple resources queried by given filters.

query Parameters

object (artworkStagedModel)

Query parameters to filter

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
customer	string^[0-9a-fA-F]{24}$ Refers to customers
micrositeUser	string^[0-9a-fA-F]{24}$ Refers to micrositeCustomers
	object (originalArtwork)
	object (previewArtwork)
previewStatus	string Default: "pending" Enum: "awaiting-upload" "pending" "in-progress" "complete" "error"
deleted	boolean Default: false
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"tenant": "string",
"microsite": "string",
"customer": "string",
"micrositeUser": "string",
"originalArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0
},
"previewArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0,
"publicUrl": "string"
},
"previewStatus": "awaiting-upload",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

[{"tenant": "string",
"microsite": "string",
"customer": "string",
"micrositeUser": "string",
"originalArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0
},
"previewArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0,
"publicUrl": "string"
},
"previewStatus": "awaiting-upload",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]

Removes multiple resources queried by given filter

Removes multiple resources queried by given filters.

query Parameters

object (artworkStagedModel)

Query parameters to filter

Responses

Response samples

200

Content type

application/json

[{"tenant": "string",
"microsite": "string",
"customer": "string",
"micrositeUser": "string",
"originalArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0
},
"previewArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0,
"publicUrl": "string"
},
"previewStatus": "awaiting-upload",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of artworkStagedModel to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/artwork-staged/%7B_id%7D

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"customer": "string",
"micrositeUser": "string",
"originalArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0
},
"previewArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0,
"publicUrl": "string"
},
"previewStatus": "awaiting-upload",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of artworkStagedModel to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
customer	string^[0-9a-fA-F]{24}$ Refers to customers
micrositeUser	string^[0-9a-fA-F]{24}$ Refers to micrositeCustomers
	object (originalArtwork)
	object (previewArtwork)
previewStatus	string Default: "pending" Enum: "awaiting-upload" "pending" "in-progress" "complete" "error"
deleted	boolean Default: false
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"microsite": "string",
"customer": "string",
"micrositeUser": "string",
"originalArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0
},
"previewArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0,
"publicUrl": "string"
},
"previewStatus": "awaiting-upload",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"customer": "string",
"micrositeUser": "string",
"originalArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0
},
"previewArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0,
"publicUrl": "string"
},
"previewStatus": "awaiting-upload",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of artworkStagedModel to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
customer	string^[0-9a-fA-F]{24}$ Refers to customers
micrositeUser	string^[0-9a-fA-F]{24}$ Refers to micrositeCustomers
	object (originalArtwork)
	object (previewArtwork)
previewStatus	string Default: "pending" Enum: "awaiting-upload" "pending" "in-progress" "complete" "error"
deleted	boolean Default: false
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"tenant": "string",
"microsite": "string",
"customer": "string",
"micrositeUser": "string",
"originalArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0
},
"previewArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0,
"publicUrl": "string"
},
"previewStatus": "awaiting-upload",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"customer": "string",
"micrositeUser": "string",
"originalArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0
},
"previewArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0,
"publicUrl": "string"
},
"previewStatus": "awaiting-upload",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of artworkStagedModel to remove

Responses

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"customer": "string",
"micrositeUser": "string",
"originalArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0
},
"previewArtwork": {"cloudBucket": "string",
"cloudFilename": "string",
"contentType": "string",
"md5": "string",
"originalFilename": "string",
"sha1": "string",
"size": 0,
"publicUrl": "string"
},
"previewStatus": "awaiting-upload",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

artwork-transports

A artwork-transports service

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (artworkTransports) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/artwork-transports?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"tenant": "string",
"order": "string",
"orderItem": "string",
"orderItemHumanId": "string",
"productionChannel": "string",
"vendor": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"downloadedBy": "string",
"downloadedByModel": "user",
"requestedBy": "string",
"requestedByModel": "user",
"url": "string",
"writeTo": "string",
"cacheKey": "string",
"status": "pending",
"errorMessage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
order	string^[0-9a-fA-F]{24}$ Refers to orders
orderItem	string^[0-9a-fA-F]{24}$ Refers to orderItems
orderItemHumanId	string
productionChannel	string^[0-9a-fA-F]{24}$ Refers to productionChannels
vendor	string^[0-9a-fA-F]{24}$ Refers to productionVendors
startedAt	string <date-time>
completedAt	string <date-time>
expiresAt	string <date-time>
downloadedBy	string^[0-9a-fA-F]{24}$
downloadedByModel	string Enum: "user" "commandCenterUser" "micrositeCustomers"
requestedBy	string^[0-9a-fA-F]{24}$
requestedByModel	string Enum: "user" "commandCenterUser" "micrositeCustomers"
url required	string
writeTo required	string
cacheKey	string
status required	string Default: "pending" Enum: "pending" "in-progress" "complete" "canceled" "failed"
errorMessage	string
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"order": "string",
"orderItem": "string",
"orderItemHumanId": "string",
"productionChannel": "string",
"vendor": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"downloadedBy": "string",
"downloadedByModel": "user",
"requestedBy": "string",
"requestedByModel": "user",
"url": "string",
"writeTo": "string",
"cacheKey": "string",
"status": "pending",
"errorMessage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

{"tenant": "string",
"order": "string",
"orderItem": "string",
"orderItemHumanId": "string",
"productionChannel": "string",
"vendor": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"downloadedBy": "string",
"downloadedByModel": "user",
"requestedBy": "string",
"requestedByModel": "user",
"url": "string",
"writeTo": "string",
"cacheKey": "string",
"status": "pending",
"errorMessage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of artworkTransports to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/artwork-transports/%7B_id%7D

Response samples

200

Content type

application/json

{"tenant": "string",
"order": "string",
"orderItem": "string",
"orderItemHumanId": "string",
"productionChannel": "string",
"vendor": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"downloadedBy": "string",
"downloadedByModel": "user",
"requestedBy": "string",
"requestedByModel": "user",
"url": "string",
"writeTo": "string",
"cacheKey": "string",
"status": "pending",
"errorMessage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of artworkTransports to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
order	string^[0-9a-fA-F]{24}$ Refers to orders
orderItem	string^[0-9a-fA-F]{24}$ Refers to orderItems
orderItemHumanId	string
productionChannel	string^[0-9a-fA-F]{24}$ Refers to productionChannels
vendor	string^[0-9a-fA-F]{24}$ Refers to productionVendors
startedAt	string <date-time>
completedAt	string <date-time>
expiresAt	string <date-time>
downloadedBy	string^[0-9a-fA-F]{24}$
downloadedByModel	string Enum: "user" "commandCenterUser" "micrositeCustomers"
requestedBy	string^[0-9a-fA-F]{24}$
requestedByModel	string Enum: "user" "commandCenterUser" "micrositeCustomers"
url required	string
writeTo required	string
cacheKey	string
status required	string Default: "pending" Enum: "pending" "in-progress" "complete" "canceled" "failed"
errorMessage	string
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"order": "string",
"orderItem": "string",
"orderItemHumanId": "string",
"productionChannel": "string",
"vendor": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"downloadedBy": "string",
"downloadedByModel": "user",
"requestedBy": "string",
"requestedByModel": "user",
"url": "string",
"writeTo": "string",
"cacheKey": "string",
"status": "pending",
"errorMessage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"order": "string",
"orderItem": "string",
"orderItemHumanId": "string",
"productionChannel": "string",
"vendor": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"downloadedBy": "string",
"downloadedByModel": "user",
"requestedBy": "string",
"requestedByModel": "user",
"url": "string",
"writeTo": "string",
"cacheKey": "string",
"status": "pending",
"errorMessage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of artworkTransports to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
order	string^[0-9a-fA-F]{24}$ Refers to orders
orderItem	string^[0-9a-fA-F]{24}$ Refers to orderItems
orderItemHumanId	string
productionChannel	string^[0-9a-fA-F]{24}$ Refers to productionChannels
vendor	string^[0-9a-fA-F]{24}$ Refers to productionVendors
startedAt	string <date-time>
completedAt	string <date-time>
expiresAt	string <date-time>
downloadedBy	string^[0-9a-fA-F]{24}$
downloadedByModel	string Enum: "user" "commandCenterUser" "micrositeCustomers"
requestedBy	string^[0-9a-fA-F]{24}$
requestedByModel	string Enum: "user" "commandCenterUser" "micrositeCustomers"
url required	string
writeTo required	string
cacheKey	string
status required	string Default: "pending" Enum: "pending" "in-progress" "complete" "canceled" "failed"
errorMessage	string
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"tenant": "string",
"order": "string",
"orderItem": "string",
"orderItemHumanId": "string",
"productionChannel": "string",
"vendor": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"downloadedBy": "string",
"downloadedByModel": "user",
"requestedBy": "string",
"requestedByModel": "user",
"url": "string",
"writeTo": "string",
"cacheKey": "string",
"status": "pending",
"errorMessage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"order": "string",
"orderItem": "string",
"orderItemHumanId": "string",
"productionChannel": "string",
"vendor": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"downloadedBy": "string",
"downloadedByModel": "user",
"requestedBy": "string",
"requestedByModel": "user",
"url": "string",
"writeTo": "string",
"cacheKey": "string",
"status": "pending",
"errorMessage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of artworkTransports to remove

Responses

Response samples

200

Content type

application/json

{"tenant": "string",
"order": "string",
"orderItem": "string",
"orderItemHumanId": "string",
"productionChannel": "string",
"vendor": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"downloadedBy": "string",
"downloadedByModel": "user",
"requestedBy": "string",
"requestedByModel": "user",
"url": "string",
"writeTo": "string",
"cacheKey": "string",
"status": "pending",
"errorMessage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

artwork-uploads

A artwork-uploads service

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
filter	object (fulfillment-staging-locations/staged) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/artwork-uploads/download-artwork-v2?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

[{ }
]

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
filter	object (fulfillment-staging-locations/staged) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/artwork-uploads/download-artwork?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

[{ }
]

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (artworkUpload) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/artwork-uploads?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"business": "string",
"customer": "string",
"order": "string",
"printJob": "string",
"multiPageThumbnails": "string",
"sequence": "string",
"originalFilename": "string",
"originalFileExtension": "string",
"originalFileSize": "string",
"uploadSessionId": "string",
"sha1": "string",
"isArchived": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

business required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
order required	string^[0-9a-fA-F]{24}$ Refers to orders
printJob required	string^[0-9a-fA-F]{24}$ Refers to orderItems
multiPageThumbnails	string
sequence	string
originalFilename	string
originalFileExtension	string
originalFileSize	string
uploadSessionId	string
sha1	string
isArchived	boolean
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"business": "string",
"customer": "string",
"order": "string",
"printJob": "string",
"multiPageThumbnails": "string",
"sequence": "string",
"originalFilename": "string",
"originalFileExtension": "string",
"originalFileSize": "string",
"uploadSessionId": "string",
"sha1": "string",
"isArchived": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

{"business": "string",
"customer": "string",
"order": "string",
"printJob": "string",
"multiPageThumbnails": "string",
"sequence": "string",
"originalFilename": "string",
"originalFileExtension": "string",
"originalFileSize": "string",
"uploadSessionId": "string",
"sha1": "string",
"isArchived": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of artworkUpload to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/artwork-uploads/%7B_id%7D

Response samples

200

Content type

application/json

{"business": "string",
"customer": "string",
"order": "string",
"printJob": "string",
"multiPageThumbnails": "string",
"sequence": "string",
"originalFilename": "string",
"originalFileExtension": "string",
"originalFileSize": "string",
"uploadSessionId": "string",
"sha1": "string",
"isArchived": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of artworkUpload to update

Request Body schema: application/json

business required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
order required	string^[0-9a-fA-F]{24}$ Refers to orders
printJob required	string^[0-9a-fA-F]{24}$ Refers to orderItems
multiPageThumbnails	string
sequence	string
originalFilename	string
originalFileExtension	string
originalFileSize	string
uploadSessionId	string
sha1	string
isArchived	boolean
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"business": "string",
"customer": "string",
"order": "string",
"printJob": "string",
"multiPageThumbnails": "string",
"sequence": "string",
"originalFilename": "string",
"originalFileExtension": "string",
"originalFileSize": "string",
"uploadSessionId": "string",
"sha1": "string",
"isArchived": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"business": "string",
"customer": "string",
"order": "string",
"printJob": "string",
"multiPageThumbnails": "string",
"sequence": "string",
"originalFilename": "string",
"originalFileExtension": "string",
"originalFileSize": "string",
"uploadSessionId": "string",
"sha1": "string",
"isArchived": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of artworkUpload to update

Request Body schema: application/json

business required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
order required	string^[0-9a-fA-F]{24}$ Refers to orders
printJob required	string^[0-9a-fA-F]{24}$ Refers to orderItems
multiPageThumbnails	string
sequence	string
originalFilename	string
originalFileExtension	string
originalFileSize	string
uploadSessionId	string
sha1	string
isArchived	boolean
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"business": "string",
"customer": "string",
"order": "string",
"printJob": "string",
"multiPageThumbnails": "string",
"sequence": "string",
"originalFilename": "string",
"originalFileExtension": "string",
"originalFileSize": "string",
"uploadSessionId": "string",
"sha1": "string",
"isArchived": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"business": "string",
"customer": "string",
"order": "string",
"printJob": "string",
"multiPageThumbnails": "string",
"sequence": "string",
"originalFilename": "string",
"originalFileExtension": "string",
"originalFileSize": "string",
"uploadSessionId": "string",
"sha1": "string",
"isArchived": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of artworkUpload to remove

Responses

Response samples

200

Content type

application/json

{"business": "string",
"customer": "string",
"order": "string",
"printJob": "string",
"multiPageThumbnails": "string",
"sequence": "string",
"originalFilename": "string",
"originalFileExtension": "string",
"originalFileSize": "string",
"uploadSessionId": "string",
"sha1": "string",
"isArchived": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

auth

A auth service

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (authenticationLog) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/auth/log?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"tenant": "string",
"microsite": "string",
"strategyType": "jwt",
"email": "string",
"authResult": true,
"ip": "string",
"httpUserAgent": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
strategyType required	string Enum: "jwt" "local" "global-local" "translator-local" "microsite-local" "customer-local"
email required	string
authResult required	boolean
ip	string
httpUserAgent	string
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"microsite": "string",
"strategyType": "jwt",
"email": "string",
"authResult": true,
"ip": "string",
"httpUserAgent": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

{"tenant": "string",
"microsite": "string",
"strategyType": "jwt",
"email": "string",
"authResult": true,
"ip": "string",
"httpUserAgent": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of authenticationLog to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/auth/log/%7B_id%7D

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"strategyType": "jwt",
"email": "string",
"authResult": true,
"ip": "string",
"httpUserAgent": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of authenticationLog to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
strategyType required	string Enum: "jwt" "local" "global-local" "translator-local" "microsite-local" "customer-local"
email required	string
authResult required	boolean
ip	string
httpUserAgent	string
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"microsite": "string",
"strategyType": "jwt",
"email": "string",
"authResult": true,
"ip": "string",
"httpUserAgent": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"strategyType": "jwt",
"email": "string",
"authResult": true,
"ip": "string",
"httpUserAgent": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of authenticationLog to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
strategyType required	string Enum: "jwt" "local" "global-local" "translator-local" "microsite-local" "customer-local"
email required	string
authResult required	boolean
ip	string
httpUserAgent	string
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"tenant": "string",
"microsite": "string",
"strategyType": "jwt",
"email": "string",
"authResult": true,
"ip": "string",
"httpUserAgent": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"strategyType": "jwt",
"email": "string",
"authResult": true,
"ip": "string",
"httpUserAgent": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of authenticationLog to remove

Responses

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"strategyType": "jwt",
"email": "string",
"authResult": true,
"ip": "string",
"httpUserAgent": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

authentication

A authentication service

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Removes the resource with id.

path Parameters

id

required

integer

ID of not-documented to remove

Responses

Response samples

200

Content type

application/json

{ }

batch-imports

A batch-imports service

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
filter	object (fulfillment-staging-locations/staged) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/batch-imports/definitions?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

[{ }
]

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

id

required

integer

ID of not-documented to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/batch-imports/definitions/%7Bid%7D

Response samples

200

Content type

application/json

{ }

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (batchImports) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/batch-imports?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"tenant": "string",
"microsite": "string",
"createdAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"requestedBy": "string",
"requestedByModel": "user",
"importKey": "string",
"importName": "string",
"params": null,
"data": [{"rawRow": null,
"status": "queued",
"errorMessages": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"numRows": 0,
"status": "queued",
"errorMessages": "string",
"gcPubSubTopic": "string",
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
createdAt	string <date-time>
startedAt	string <date-time>
completedAt	string <date-time>
expiresAt	string <date-time>
requestedBy required	string^[0-9a-fA-F]{24}$
requestedByModel required	string Enum: "user" "commandCenterUser" "micrositeCustomers"
importKey required	string
importName required	string
params	any
	Array of objects (itemOf_data)
numRows required	number
status required	string Default: "queued" Enum: "queued" "starting" "in-progress" "complete" "complete-with-failures" "failure" "canceled"
errorMessages	string
gcPubSubTopic	string
	Array of objects (itemOf_metadata)
_id	string^[0-9a-fA-F]{24}$
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"microsite": "string",
"createdAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"requestedBy": "string",
"requestedByModel": "user",
"importKey": "string",
"importName": "string",
"params": null,
"data": [{"rawRow": null,
"status": "queued",
"errorMessages": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"numRows": 0,
"status": "queued",
"errorMessages": "string",
"gcPubSubTopic": "string",
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

{"tenant": "string",
"microsite": "string",
"createdAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"requestedBy": "string",
"requestedByModel": "user",
"importKey": "string",
"importName": "string",
"params": null,
"data": [{"rawRow": null,
"status": "queued",
"errorMessages": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"numRows": 0,
"status": "queued",
"errorMessages": "string",
"gcPubSubTopic": "string",
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of batchImports to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/batch-imports/%7B_id%7D

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"createdAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"requestedBy": "string",
"requestedByModel": "user",
"importKey": "string",
"importName": "string",
"params": null,
"data": [{"rawRow": null,
"status": "queued",
"errorMessages": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"numRows": 0,
"status": "queued",
"errorMessages": "string",
"gcPubSubTopic": "string",
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of batchImports to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
createdAt	string <date-time>
startedAt	string <date-time>
completedAt	string <date-time>
expiresAt	string <date-time>
requestedBy required	string^[0-9a-fA-F]{24}$
requestedByModel required	string Enum: "user" "commandCenterUser" "micrositeCustomers"
importKey required	string
importName required	string
params	any
	Array of objects (itemOf_data)
numRows required	number
status required	string Default: "queued" Enum: "queued" "starting" "in-progress" "complete" "complete-with-failures" "failure" "canceled"
errorMessages	string
gcPubSubTopic	string
	Array of objects (itemOf_metadata)
_id	string^[0-9a-fA-F]{24}$
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"microsite": "string",
"createdAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"requestedBy": "string",
"requestedByModel": "user",
"importKey": "string",
"importName": "string",
"params": null,
"data": [{"rawRow": null,
"status": "queued",
"errorMessages": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"numRows": 0,
"status": "queued",
"errorMessages": "string",
"gcPubSubTopic": "string",
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"createdAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"requestedBy": "string",
"requestedByModel": "user",
"importKey": "string",
"importName": "string",
"params": null,
"data": [{"rawRow": null,
"status": "queued",
"errorMessages": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"numRows": 0,
"status": "queued",
"errorMessages": "string",
"gcPubSubTopic": "string",
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of batchImports to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
createdAt	string <date-time>
startedAt	string <date-time>
completedAt	string <date-time>
expiresAt	string <date-time>
requestedBy required	string^[0-9a-fA-F]{24}$
requestedByModel required	string Enum: "user" "commandCenterUser" "micrositeCustomers"
importKey required	string
importName required	string
params	any
	Array of objects (itemOf_data)
numRows required	number
status required	string Default: "queued" Enum: "queued" "starting" "in-progress" "complete" "complete-with-failures" "failure" "canceled"
errorMessages	string
gcPubSubTopic	string
	Array of objects (itemOf_metadata)
_id	string^[0-9a-fA-F]{24}$
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"tenant": "string",
"microsite": "string",
"createdAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"requestedBy": "string",
"requestedByModel": "user",
"importKey": "string",
"importName": "string",
"params": null,
"data": [{"rawRow": null,
"status": "queued",
"errorMessages": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"numRows": 0,
"status": "queued",
"errorMessages": "string",
"gcPubSubTopic": "string",
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"createdAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"requestedBy": "string",
"requestedByModel": "user",
"importKey": "string",
"importName": "string",
"params": null,
"data": [{"rawRow": null,
"status": "queued",
"errorMessages": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"numRows": 0,
"status": "queued",
"errorMessages": "string",
"gcPubSubTopic": "string",
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of batchImports to remove

Responses

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"createdAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"requestedBy": "string",
"requestedByModel": "user",
"importKey": "string",
"importName": "string",
"params": null,
"data": [{"rawRow": null,
"status": "queued",
"errorMessages": "string",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"numRows": 0,
"status": "queued",
"errorMessages": "string",
"gcPubSubTopic": "string",
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

cart

A cart service

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (cartSavedItems) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/cart/saved-items?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"tenant": "string",
"customer": "string",
"microsite": "string",
"micrositeUser": "string",
"product": "string",
"category": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"typeName": "string",
"typeKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"fromCompositeProduct": "string",
"fromCompositeQuantity": null,
"variantValues": [{"type": "string",
"value": "string",
"typeName": "string",
"typeKey": "string",
"valueName": "string",
"valueKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isCustom": false,
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"description": "string",
"price": 0,
"priceOverride": true,
"tax": 0,
"priceWithTax": 0,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"packageDims": {"width": 0,
"height": 0,
"length": 0,
"units": "string"
},
"unitType": "inch",
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnTotal": 0,
"staticName": "string",
"isPriority": false,
"images": [{"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplate": "string",
"designTemplateSecondary": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplateFieldset": "string",
"designTemplateRenderContext": null,
"renderToken": "string",
"artworkVariantValues": [{"type": "string",
"value": "string",
"artwork": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"artwork": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customFields": [{"type": "text",
"key": "string",
"label": "string",
"options": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isDigitalDelivery": false,
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"miscUploads": ["string"
],
"initialStatus": "string",
"triggerOrderApproval": true,
"discount": 0,
"compositeVariants": null,
"productionChannel": "string",
"vendor": "string",
"dueDate": "2019-08-24T14:15:22Z",
"poHumanId": "string",
"projectCode": "string",
"compositeSelectedQuantities": [{"id": "string",
"quantity": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeSelectedProducts": [{"id": "string",
"product": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeDesignTemplates": [{"id": "string",
"designTemplate": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designJobInitialNoteContent": "string",
"designJobInitialNoteAttachments": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer	string^[0-9a-fA-F]{24}$ Refers to customers
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
micrositeUser	string^[0-9a-fA-F]{24}$ Refers to micrositeCustomers
product	string^[0-9a-fA-F]{24}$ Refers to ProductLegacy
category	string^[0-9a-fA-F]{24}$ Refers to productCategoryLegacy
	Array of objects (itemOf_attributes)
customerReferenceName	string
fromCompositeProduct	string^[0-9a-fA-F]{24}$ Refers to ProductLegacy
fromCompositeQuantity	number or null Default: null
	Array of objects (itemOf_variantValues)
isCustom	boolean Default: false
isCustomTrim	boolean Default: false
customTrimWidth	number or null Default: null
customTrimHeight	number or null Default: null
description	string
price required	number
priceOverride	boolean
tax	number
priceWithTax	number
designPrice	number
quantity required	number
width	number or null Default: null
height	number or null Default: null
weight	number or null Default: null
length	number
depth	number
	object (packageDims)
unitType	string Default: "inch" Enum: "inch" "cm" "meter" "foot"
cartonType	string^[0-9a-fA-F]{24}$ Refers to cartonTypes
cartonTypeName	string
timeMin	number
timeMax	number
orientation	string Enum: "landscape" "portrait"
isShippable	boolean Default: true
wantDesign	boolean Default: false
turnaroundServiceType	number or null Default: null
turnaround	string
pricingMethod	number
	Array of objects (itemOf_addOns)
addOnTotal	number
staticName	string
isPriority	boolean Default: false
	Array of objects (itemOf_images)
designTemplate	string^[0-9a-fA-F]{24}$ Refers to designTemplates
designTemplateSecondary	string^[0-9a-fA-F]{24}$ Refers to designTemplates
	Array of objects (itemOf_designTemplateFields)
designTemplateFieldset	string^[0-9a-fA-F]{24}$ Refers to designTemplateFieldset
designTemplateRenderContext	any
renderToken	string
	Array of objects (itemOf_artworkVariantValues)
artwork	string
	Array of objects (itemOf_uploadSlots)
	Array of objects (itemOf_customFields)
isDigitalDelivery	boolean Default: false
	Array of objects (itemOf_metadata)
miscUploads	Array of strings non-empty
initialStatus	string Refers to jobStatuses
triggerOrderApproval	boolean
discount	number
compositeVariants	any
productionChannel	string^[0-9a-fA-F]{24}$ Refers to productionChannels
vendor	string^[0-9a-fA-F]{24}$ Refers to productionVendors
dueDate	string <date-time>
poHumanId	string
projectCode	string
	Array of objects (itemOf_compositeSelectedQuantities)
	Array of objects (itemOf_compositeSelectedProducts)
	Array of objects (itemOf_compositeDesignTemplates)
designJobInitialNoteContent	string
designJobInitialNoteAttachments	Array of strings
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"customer": "string",
"microsite": "string",
"micrositeUser": "string",
"product": "string",
"category": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"typeName": "string",
"typeKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"fromCompositeProduct": "string",
"fromCompositeQuantity": null,
"variantValues": [{"type": "string",
"value": "string",
"typeName": "string",
"typeKey": "string",
"valueName": "string",
"valueKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isCustom": false,
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"description": "string",
"price": 0,
"priceOverride": true,
"tax": 0,
"priceWithTax": 0,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"packageDims": {"width": 0,
"height": 0,
"length": 0,
"units": "string"
},
"unitType": "inch",
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnTotal": 0,
"staticName": "string",
"isPriority": false,
"images": [{"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplate": "string",
"designTemplateSecondary": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplateFieldset": "string",
"designTemplateRenderContext": null,
"renderToken": "string",
"artworkVariantValues": [{"type": "string",
"value": "string",
"artwork": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"artwork": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customFields": [{"type": "text",
"key": "string",
"label": "string",
"options": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isDigitalDelivery": false,
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"miscUploads": ["string"
],
"initialStatus": "string",
"triggerOrderApproval": true,
"discount": 0,
"compositeVariants": null,
"productionChannel": "string",
"vendor": "string",
"dueDate": "2019-08-24T14:15:22Z",
"poHumanId": "string",
"projectCode": "string",
"compositeSelectedQuantities": [{"id": "string",
"quantity": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeSelectedProducts": [{"id": "string",
"product": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeDesignTemplates": [{"id": "string",
"designTemplate": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designJobInitialNoteContent": "string",
"designJobInitialNoteAttachments": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

{"tenant": "string",
"customer": "string",
"microsite": "string",
"micrositeUser": "string",
"product": "string",
"category": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"typeName": "string",
"typeKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"fromCompositeProduct": "string",
"fromCompositeQuantity": null,
"variantValues": [{"type": "string",
"value": "string",
"typeName": "string",
"typeKey": "string",
"valueName": "string",
"valueKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isCustom": false,
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"description": "string",
"price": 0,
"priceOverride": true,
"tax": 0,
"priceWithTax": 0,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"packageDims": {"width": 0,
"height": 0,
"length": 0,
"units": "string"
},
"unitType": "inch",
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnTotal": 0,
"staticName": "string",
"isPriority": false,
"images": [{"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplate": "string",
"designTemplateSecondary": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplateFieldset": "string",
"designTemplateRenderContext": null,
"renderToken": "string",
"artworkVariantValues": [{"type": "string",
"value": "string",
"artwork": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"artwork": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customFields": [{"type": "text",
"key": "string",
"label": "string",
"options": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isDigitalDelivery": false,
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"miscUploads": ["string"
],
"initialStatus": "string",
"triggerOrderApproval": true,
"discount": 0,
"compositeVariants": null,
"productionChannel": "string",
"vendor": "string",
"dueDate": "2019-08-24T14:15:22Z",
"poHumanId": "string",
"projectCode": "string",
"compositeSelectedQuantities": [{"id": "string",
"quantity": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeSelectedProducts": [{"id": "string",
"product": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeDesignTemplates": [{"id": "string",
"designTemplate": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designJobInitialNoteContent": "string",
"designJobInitialNoteAttachments": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of cartSavedItems to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/cart/saved-items/%7B_id%7D

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"microsite": "string",
"micrositeUser": "string",
"product": "string",
"category": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"typeName": "string",
"typeKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"fromCompositeProduct": "string",
"fromCompositeQuantity": null,
"variantValues": [{"type": "string",
"value": "string",
"typeName": "string",
"typeKey": "string",
"valueName": "string",
"valueKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isCustom": false,
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"description": "string",
"price": 0,
"priceOverride": true,
"tax": 0,
"priceWithTax": 0,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"packageDims": {"width": 0,
"height": 0,
"length": 0,
"units": "string"
},
"unitType": "inch",
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnTotal": 0,
"staticName": "string",
"isPriority": false,
"images": [{"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplate": "string",
"designTemplateSecondary": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplateFieldset": "string",
"designTemplateRenderContext": null,
"renderToken": "string",
"artworkVariantValues": [{"type": "string",
"value": "string",
"artwork": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"artwork": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customFields": [{"type": "text",
"key": "string",
"label": "string",
"options": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isDigitalDelivery": false,
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"miscUploads": ["string"
],
"initialStatus": "string",
"triggerOrderApproval": true,
"discount": 0,
"compositeVariants": null,
"productionChannel": "string",
"vendor": "string",
"dueDate": "2019-08-24T14:15:22Z",
"poHumanId": "string",
"projectCode": "string",
"compositeSelectedQuantities": [{"id": "string",
"quantity": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeSelectedProducts": [{"id": "string",
"product": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeDesignTemplates": [{"id": "string",
"designTemplate": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designJobInitialNoteContent": "string",
"designJobInitialNoteAttachments": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of cartSavedItems to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer	string^[0-9a-fA-F]{24}$ Refers to customers
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
micrositeUser	string^[0-9a-fA-F]{24}$ Refers to micrositeCustomers
product	string^[0-9a-fA-F]{24}$ Refers to ProductLegacy
category	string^[0-9a-fA-F]{24}$ Refers to productCategoryLegacy
	Array of objects (itemOf_attributes)
customerReferenceName	string
fromCompositeProduct	string^[0-9a-fA-F]{24}$ Refers to ProductLegacy
fromCompositeQuantity	number or null Default: null
	Array of objects (itemOf_variantValues)
isCustom	boolean Default: false
isCustomTrim	boolean Default: false
customTrimWidth	number or null Default: null
customTrimHeight	number or null Default: null
description	string
price required	number
priceOverride	boolean
tax	number
priceWithTax	number
designPrice	number
quantity required	number
width	number or null Default: null
height	number or null Default: null
weight	number or null Default: null
length	number
depth	number
	object (packageDims)
unitType	string Default: "inch" Enum: "inch" "cm" "meter" "foot"
cartonType	string^[0-9a-fA-F]{24}$ Refers to cartonTypes
cartonTypeName	string
timeMin	number
timeMax	number
orientation	string Enum: "landscape" "portrait"
isShippable	boolean Default: true
wantDesign	boolean Default: false
turnaroundServiceType	number or null Default: null
turnaround	string
pricingMethod	number
	Array of objects (itemOf_addOns)
addOnTotal	number
staticName	string
isPriority	boolean Default: false
	Array of objects (itemOf_images)
designTemplate	string^[0-9a-fA-F]{24}$ Refers to designTemplates
designTemplateSecondary	string^[0-9a-fA-F]{24}$ Refers to designTemplates
	Array of objects (itemOf_designTemplateFields)
designTemplateFieldset	string^[0-9a-fA-F]{24}$ Refers to designTemplateFieldset
designTemplateRenderContext	any
renderToken	string
	Array of objects (itemOf_artworkVariantValues)
artwork	string
	Array of objects (itemOf_uploadSlots)
	Array of objects (itemOf_customFields)
isDigitalDelivery	boolean Default: false
	Array of objects (itemOf_metadata)
miscUploads	Array of strings non-empty
initialStatus	string Refers to jobStatuses
triggerOrderApproval	boolean
discount	number
compositeVariants	any
productionChannel	string^[0-9a-fA-F]{24}$ Refers to productionChannels
vendor	string^[0-9a-fA-F]{24}$ Refers to productionVendors
dueDate	string <date-time>
poHumanId	string
projectCode	string
	Array of objects (itemOf_compositeSelectedQuantities)
	Array of objects (itemOf_compositeSelectedProducts)
	Array of objects (itemOf_compositeDesignTemplates)
designJobInitialNoteContent	string
designJobInitialNoteAttachments	Array of strings
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"customer": "string",
"microsite": "string",
"micrositeUser": "string",
"product": "string",
"category": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"typeName": "string",
"typeKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"fromCompositeProduct": "string",
"fromCompositeQuantity": null,
"variantValues": [{"type": "string",
"value": "string",
"typeName": "string",
"typeKey": "string",
"valueName": "string",
"valueKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isCustom": false,
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"description": "string",
"price": 0,
"priceOverride": true,
"tax": 0,
"priceWithTax": 0,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"packageDims": {"width": 0,
"height": 0,
"length": 0,
"units": "string"
},
"unitType": "inch",
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnTotal": 0,
"staticName": "string",
"isPriority": false,
"images": [{"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplate": "string",
"designTemplateSecondary": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplateFieldset": "string",
"designTemplateRenderContext": null,
"renderToken": "string",
"artworkVariantValues": [{"type": "string",
"value": "string",
"artwork": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"artwork": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customFields": [{"type": "text",
"key": "string",
"label": "string",
"options": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isDigitalDelivery": false,
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"miscUploads": ["string"
],
"initialStatus": "string",
"triggerOrderApproval": true,
"discount": 0,
"compositeVariants": null,
"productionChannel": "string",
"vendor": "string",
"dueDate": "2019-08-24T14:15:22Z",
"poHumanId": "string",
"projectCode": "string",
"compositeSelectedQuantities": [{"id": "string",
"quantity": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeSelectedProducts": [{"id": "string",
"product": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeDesignTemplates": [{"id": "string",
"designTemplate": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designJobInitialNoteContent": "string",
"designJobInitialNoteAttachments": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"microsite": "string",
"micrositeUser": "string",
"product": "string",
"category": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"typeName": "string",
"typeKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"fromCompositeProduct": "string",
"fromCompositeQuantity": null,
"variantValues": [{"type": "string",
"value": "string",
"typeName": "string",
"typeKey": "string",
"valueName": "string",
"valueKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isCustom": false,
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"description": "string",
"price": 0,
"priceOverride": true,
"tax": 0,
"priceWithTax": 0,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"packageDims": {"width": 0,
"height": 0,
"length": 0,
"units": "string"
},
"unitType": "inch",
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnTotal": 0,
"staticName": "string",
"isPriority": false,
"images": [{"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplate": "string",
"designTemplateSecondary": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplateFieldset": "string",
"designTemplateRenderContext": null,
"renderToken": "string",
"artworkVariantValues": [{"type": "string",
"value": "string",
"artwork": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"artwork": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customFields": [{"type": "text",
"key": "string",
"label": "string",
"options": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isDigitalDelivery": false,
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"miscUploads": ["string"
],
"initialStatus": "string",
"triggerOrderApproval": true,
"discount": 0,
"compositeVariants": null,
"productionChannel": "string",
"vendor": "string",
"dueDate": "2019-08-24T14:15:22Z",
"poHumanId": "string",
"projectCode": "string",
"compositeSelectedQuantities": [{"id": "string",
"quantity": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeSelectedProducts": [{"id": "string",
"product": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeDesignTemplates": [{"id": "string",
"designTemplate": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designJobInitialNoteContent": "string",
"designJobInitialNoteAttachments": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of cartSavedItems to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer	string^[0-9a-fA-F]{24}$ Refers to customers
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
micrositeUser	string^[0-9a-fA-F]{24}$ Refers to micrositeCustomers
product	string^[0-9a-fA-F]{24}$ Refers to ProductLegacy
category	string^[0-9a-fA-F]{24}$ Refers to productCategoryLegacy
	Array of objects (itemOf_attributes)
customerReferenceName	string
fromCompositeProduct	string^[0-9a-fA-F]{24}$ Refers to ProductLegacy
fromCompositeQuantity	number or null Default: null
	Array of objects (itemOf_variantValues)
isCustom	boolean Default: false
isCustomTrim	boolean Default: false
customTrimWidth	number or null Default: null
customTrimHeight	number or null Default: null
description	string
price required	number
priceOverride	boolean
tax	number
priceWithTax	number
designPrice	number
quantity required	number
width	number or null Default: null
height	number or null Default: null
weight	number or null Default: null
length	number
depth	number
	object (packageDims)
unitType	string Default: "inch" Enum: "inch" "cm" "meter" "foot"
cartonType	string^[0-9a-fA-F]{24}$ Refers to cartonTypes
cartonTypeName	string
timeMin	number
timeMax	number
orientation	string Enum: "landscape" "portrait"
isShippable	boolean Default: true
wantDesign	boolean Default: false
turnaroundServiceType	number or null Default: null
turnaround	string
pricingMethod	number
	Array of objects (itemOf_addOns)
addOnTotal	number
staticName	string
isPriority	boolean Default: false
	Array of objects (itemOf_images)
designTemplate	string^[0-9a-fA-F]{24}$ Refers to designTemplates
designTemplateSecondary	string^[0-9a-fA-F]{24}$ Refers to designTemplates
	Array of objects (itemOf_designTemplateFields)
designTemplateFieldset	string^[0-9a-fA-F]{24}$ Refers to designTemplateFieldset
designTemplateRenderContext	any
renderToken	string
	Array of objects (itemOf_artworkVariantValues)
artwork	string
	Array of objects (itemOf_uploadSlots)
	Array of objects (itemOf_customFields)
isDigitalDelivery	boolean Default: false
	Array of objects (itemOf_metadata)
miscUploads	Array of strings non-empty
initialStatus	string Refers to jobStatuses
triggerOrderApproval	boolean
discount	number
compositeVariants	any
productionChannel	string^[0-9a-fA-F]{24}$ Refers to productionChannels
vendor	string^[0-9a-fA-F]{24}$ Refers to productionVendors
dueDate	string <date-time>
poHumanId	string
projectCode	string
	Array of objects (itemOf_compositeSelectedQuantities)
	Array of objects (itemOf_compositeSelectedProducts)
	Array of objects (itemOf_compositeDesignTemplates)
designJobInitialNoteContent	string
designJobInitialNoteAttachments	Array of strings
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"tenant": "string",
"customer": "string",
"microsite": "string",
"micrositeUser": "string",
"product": "string",
"category": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"typeName": "string",
"typeKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"fromCompositeProduct": "string",
"fromCompositeQuantity": null,
"variantValues": [{"type": "string",
"value": "string",
"typeName": "string",
"typeKey": "string",
"valueName": "string",
"valueKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isCustom": false,
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"description": "string",
"price": 0,
"priceOverride": true,
"tax": 0,
"priceWithTax": 0,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"packageDims": {"width": 0,
"height": 0,
"length": 0,
"units": "string"
},
"unitType": "inch",
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnTotal": 0,
"staticName": "string",
"isPriority": false,
"images": [{"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplate": "string",
"designTemplateSecondary": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplateFieldset": "string",
"designTemplateRenderContext": null,
"renderToken": "string",
"artworkVariantValues": [{"type": "string",
"value": "string",
"artwork": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"artwork": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customFields": [{"type": "text",
"key": "string",
"label": "string",
"options": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isDigitalDelivery": false,
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"miscUploads": ["string"
],
"initialStatus": "string",
"triggerOrderApproval": true,
"discount": 0,
"compositeVariants": null,
"productionChannel": "string",
"vendor": "string",
"dueDate": "2019-08-24T14:15:22Z",
"poHumanId": "string",
"projectCode": "string",
"compositeSelectedQuantities": [{"id": "string",
"quantity": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeSelectedProducts": [{"id": "string",
"product": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeDesignTemplates": [{"id": "string",
"designTemplate": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designJobInitialNoteContent": "string",
"designJobInitialNoteAttachments": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"microsite": "string",
"micrositeUser": "string",
"product": "string",
"category": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"typeName": "string",
"typeKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"fromCompositeProduct": "string",
"fromCompositeQuantity": null,
"variantValues": [{"type": "string",
"value": "string",
"typeName": "string",
"typeKey": "string",
"valueName": "string",
"valueKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isCustom": false,
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"description": "string",
"price": 0,
"priceOverride": true,
"tax": 0,
"priceWithTax": 0,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"packageDims": {"width": 0,
"height": 0,
"length": 0,
"units": "string"
},
"unitType": "inch",
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnTotal": 0,
"staticName": "string",
"isPriority": false,
"images": [{"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplate": "string",
"designTemplateSecondary": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplateFieldset": "string",
"designTemplateRenderContext": null,
"renderToken": "string",
"artworkVariantValues": [{"type": "string",
"value": "string",
"artwork": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"artwork": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customFields": [{"type": "text",
"key": "string",
"label": "string",
"options": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isDigitalDelivery": false,
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"miscUploads": ["string"
],
"initialStatus": "string",
"triggerOrderApproval": true,
"discount": 0,
"compositeVariants": null,
"productionChannel": "string",
"vendor": "string",
"dueDate": "2019-08-24T14:15:22Z",
"poHumanId": "string",
"projectCode": "string",
"compositeSelectedQuantities": [{"id": "string",
"quantity": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeSelectedProducts": [{"id": "string",
"product": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeDesignTemplates": [{"id": "string",
"designTemplate": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designJobInitialNoteContent": "string",
"designJobInitialNoteAttachments": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of cartSavedItems to remove

Responses

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"microsite": "string",
"micrositeUser": "string",
"product": "string",
"category": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"typeName": "string",
"typeKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"fromCompositeProduct": "string",
"fromCompositeQuantity": null,
"variantValues": [{"type": "string",
"value": "string",
"typeName": "string",
"typeKey": "string",
"valueName": "string",
"valueKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isCustom": false,
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"description": "string",
"price": 0,
"priceOverride": true,
"tax": 0,
"priceWithTax": 0,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"packageDims": {"width": 0,
"height": 0,
"length": 0,
"units": "string"
},
"unitType": "inch",
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnTotal": 0,
"staticName": "string",
"isPriority": false,
"images": [{"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplate": "string",
"designTemplateSecondary": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplateFieldset": "string",
"designTemplateRenderContext": null,
"renderToken": "string",
"artworkVariantValues": [{"type": "string",
"value": "string",
"artwork": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"artwork": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customFields": [{"type": "text",
"key": "string",
"label": "string",
"options": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isDigitalDelivery": false,
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"miscUploads": ["string"
],
"initialStatus": "string",
"triggerOrderApproval": true,
"discount": 0,
"compositeVariants": null,
"productionChannel": "string",
"vendor": "string",
"dueDate": "2019-08-24T14:15:22Z",
"poHumanId": "string",
"projectCode": "string",
"compositeSelectedQuantities": [{"id": "string",
"quantity": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeSelectedProducts": [{"id": "string",
"product": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeDesignTemplates": [{"id": "string",
"designTemplate": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designJobInitialNoteContent": "string",
"designJobInitialNoteAttachments": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (carts) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/cart?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"tenant": "string",
"customer": "string",
"salesPerson": "string",
"items": [{"product": "string",
"category": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"typeName": "string",
"typeKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"fromCompositeProduct": "string",
"fromCompositeQuantity": null,
"variantValues": [{"type": "string",
"value": "string",
"typeName": "string",
"typeKey": "string",
"valueName": "string",
"valueKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isCustom": false,
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"description": "string",
"price": 0,
"priceOverride": true,
"tax": 0,
"priceWithTax": 0,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"packageDims": {"width": 0,
"height": 0,
"length": 0,
"units": "string"
},
"unitType": "inch",
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnTotal": 0,
"staticName": "string",
"isPriority": false,
"images": [{"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplate": "string",
"designTemplateSecondary": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplateFieldset": "string",
"designTemplateRenderContext": null,
"renderToken": "string",
"artworkVariantValues": [{"type": "string",
"value": "string",
"artwork": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"artwork": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customFields": [{"type": "text",
"key": "string",
"label": "string",
"options": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isDigitalDelivery": false,
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"miscUploads": ["string"
],
"initialStatus": "string",
"triggerOrderApproval": true,
"discount": 0,
"compositeVariants": null,
"productionChannel": "string",
"vendor": "string",
"dueDate": "2019-08-24T14:15:22Z",
"poHumanId": "string",
"projectCode": "string",
"compositeSelectedQuantities": [{"id": "string",
"quantity": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeSelectedProducts": [{"id": "string",
"product": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeDesignTemplates": [{"id": "string",
"designTemplate": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designJobInitialNoteContent": "string",
"designJobInitialNoteAttachments": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"subtotal": 0,
"airCargoAmount": 0,
"shipping": 0,
"shippingDiscount": 0,
"salesTax": 0,
"taxExShipping": 0,
"discount": 0,
"total": 0,
"isTaxCalcDisabled": false,
"isOrderApprovalRequired": false,
"shipTo": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"billTo": {"companyName": "string",
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phoneNumber": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"blindShipFrom": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"availableShippingMethods": [null
],
"shipOutAddressInputMethod": "open",
"isCartAddressBookEnabled": false,
"isUseRecentAddressEnabled": false,
"isCostCenterInputEnabled": false,
"isPOInputEnabled": false,
"shipFromControl": false,
"showShippingRates": true,
"availableShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"deliveryDays": 0,
"deliveryDate": "2019-08-24T14:15:22Z",
"deliveryDateGuaranteed": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"staticShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"deliveryDays": 0,
"deliveryDate": "2019-08-24T14:15:22Z",
"deliveryDateGuaranteed": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"selectedShippingMethod": "string",
"selectedShippingService": "string",
"selectedShippingRate": "string",
"selectedAirportCode": "string",
"selectedPickupLocation": "string",
"appliedPromo": "string",
"appliedPromoCode": "string",
"appliedPromoCodeDescription": "string",
"order": "string",
"invoice": "string",
"convertedToOrder": false,
"microsite": "string",
"micrositeUser": "string",
"costCenter": "string",
"channel": "store-front",
"po": "string",
"foreignId": "string",
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"orderRef": "string",
"miscInfo": "string",
"arriveBy": "string",
"notification": [{"recipientName": "string",
"recipientAccount": "string",
"notificationType": "order-confirmation",
"deliveryStrategy": "email",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"shipmentPayment": {"type": "SENDER",
"account": "string",
"countryCode": "string",
"postalCode": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"easypostCarrierAccounts": ["string"
],
"additionalRecipients": [{"email": "string",
"name": "string",
"type": "to",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerSuppliedPackingSlip": "string",
"intakeChannel": "string",
"notificationPreference": "email",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer	string^[0-9a-fA-F]{24}$ Refers to customers
salesPerson	string^[0-9a-fA-F]{24}$ Refers to salesPeople
	Array of objects (itemOf_items)
subtotal	number Default: 0
airCargoAmount	number
shipping	number Default: 0
shippingDiscount	number Default: 0
salesTax	number Default: 0
taxExShipping	number Default: 0
discount	number Default: 0
total	number Default: 0
isTaxCalcDisabled	boolean Default: false
isOrderApprovalRequired	boolean Default: false
	object (shipTo)
	object (billTo)
	object (blindShipFrom)
availableShippingMethods	Array of any
shipOutAddressInputMethod	string Default: "open" Enum: "open" "address-book" "read-only"
isCartAddressBookEnabled	boolean Default: false
isUseRecentAddressEnabled	boolean Default: false
isCostCenterInputEnabled	boolean Default: false
isPOInputEnabled	boolean Default: false
shipFromControl	boolean Default: false
showShippingRates	boolean Default: true
	Array of objects (itemOf_availableShippingRates)
	Array of objects (itemOf_staticShippingRates)
selectedShippingMethod	string
selectedShippingService	string
selectedShippingRate	string
selectedAirportCode	string
selectedPickupLocation	string^[0-9a-fA-F]{24}$ Refers to pickupLocations
appliedPromo	string^[0-9a-fA-F]{24}$ Refers to promoCodes
appliedPromoCode	string
appliedPromoCodeDescription	string
order	string^[0-9a-fA-F]{24}$ Refers to orders
invoice	string^[0-9a-fA-F]{24}$ Refers to invoices
convertedToOrder	boolean Default: false
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
micrositeUser	string^[0-9a-fA-F]{24}$ Refers to micrositeCustomers
costCenter	string
channel	string Enum: "store-front" "dashboard" "api" "custom-quote"
po	string
foreignId	string
	Array of objects (itemOf_metadata)
orderRef	string
miscInfo	string
arriveBy	string
	Array of objects (itemOf_notification)
	object (shipmentPayment)
easypostCarrierAccounts	Array of strings
	Array of objects (itemOf_additionalRecipients)
customerSuppliedPackingSlip	string^[0-9a-fA-F]{24}$ Refers to uploadLog
intakeChannel	string^[0-9a-fA-F]{24}$ Refers to intakeChannels
notificationPreference	string Default: "email" Enum: "email" "sms"
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"customer": "string",
"salesPerson": "string",
"items": [{"product": "string",
"category": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"typeName": "string",
"typeKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"fromCompositeProduct": "string",
"fromCompositeQuantity": null,
"variantValues": [{"type": "string",
"value": "string",
"typeName": "string",
"typeKey": "string",
"valueName": "string",
"valueKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isCustom": false,
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"description": "string",
"price": 0,
"priceOverride": true,
"tax": 0,
"priceWithTax": 0,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"packageDims": {"width": 0,
"height": 0,
"length": 0,
"units": "string"
},
"unitType": "inch",
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnTotal": 0,
"staticName": "string",
"isPriority": false,
"images": [{"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplate": "string",
"designTemplateSecondary": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplateFieldset": "string",
"designTemplateRenderContext": null,
"renderToken": "string",
"artworkVariantValues": [{"type": "string",
"value": "string",
"artwork": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"artwork": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customFields": [{"type": "text",
"key": "string",
"label": "string",
"options": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isDigitalDelivery": false,
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"miscUploads": ["string"
],
"initialStatus": "string",
"triggerOrderApproval": true,
"discount": 0,
"compositeVariants": null,
"productionChannel": "string",
"vendor": "string",
"dueDate": "2019-08-24T14:15:22Z",
"poHumanId": "string",
"projectCode": "string",
"compositeSelectedQuantities": [{"id": "string",
"quantity": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeSelectedProducts": [{"id": "string",
"product": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeDesignTemplates": [{"id": "string",
"designTemplate": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designJobInitialNoteContent": "string",
"designJobInitialNoteAttachments": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"subtotal": 0,
"airCargoAmount": 0,
"shipping": 0,
"shippingDiscount": 0,
"salesTax": 0,
"taxExShipping": 0,
"discount": 0,
"total": 0,
"isTaxCalcDisabled": false,
"isOrderApprovalRequired": false,
"shipTo": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"billTo": {"companyName": "string",
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phoneNumber": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"blindShipFrom": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"availableShippingMethods": [null
],
"shipOutAddressInputMethod": "open",
"isCartAddressBookEnabled": false,
"isUseRecentAddressEnabled": false,
"isCostCenterInputEnabled": false,
"isPOInputEnabled": false,
"shipFromControl": false,
"showShippingRates": true,
"availableShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"deliveryDays": 0,
"deliveryDate": "2019-08-24T14:15:22Z",
"deliveryDateGuaranteed": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"staticShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"deliveryDays": 0,
"deliveryDate": "2019-08-24T14:15:22Z",
"deliveryDateGuaranteed": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"selectedShippingMethod": "string",
"selectedShippingService": "string",
"selectedShippingRate": "string",
"selectedAirportCode": "string",
"selectedPickupLocation": "string",
"appliedPromo": "string",
"appliedPromoCode": "string",
"appliedPromoCodeDescription": "string",
"order": "string",
"invoice": "string",
"convertedToOrder": false,
"microsite": "string",
"micrositeUser": "string",
"costCenter": "string",
"channel": "store-front",
"po": "string",
"foreignId": "string",
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"orderRef": "string",
"miscInfo": "string",
"arriveBy": "string",
"notification": [{"recipientName": "string",
"recipientAccount": "string",
"notificationType": "order-confirmation",
"deliveryStrategy": "email",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"shipmentPayment": {"type": "SENDER",
"account": "string",
"countryCode": "string",
"postalCode": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"easypostCarrierAccounts": ["string"
],
"additionalRecipients": [{"email": "string",
"name": "string",
"type": "to",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerSuppliedPackingSlip": "string",
"intakeChannel": "string",
"notificationPreference": "email",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

{"tenant": "string",
"customer": "string",
"salesPerson": "string",
"items": [{"product": "string",
"category": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"typeName": "string",
"typeKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"fromCompositeProduct": "string",
"fromCompositeQuantity": null,
"variantValues": [{"type": "string",
"value": "string",
"typeName": "string",
"typeKey": "string",
"valueName": "string",
"valueKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isCustom": false,
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"description": "string",
"price": 0,
"priceOverride": true,
"tax": 0,
"priceWithTax": 0,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"packageDims": {"width": 0,
"height": 0,
"length": 0,
"units": "string"
},
"unitType": "inch",
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnTotal": 0,
"staticName": "string",
"isPriority": false,
"images": [{"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplate": "string",
"designTemplateSecondary": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplateFieldset": "string",
"designTemplateRenderContext": null,
"renderToken": "string",
"artworkVariantValues": [{"type": "string",
"value": "string",
"artwork": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"artwork": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customFields": [{"type": "text",
"key": "string",
"label": "string",
"options": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isDigitalDelivery": false,
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"miscUploads": ["string"
],
"initialStatus": "string",
"triggerOrderApproval": true,
"discount": 0,
"compositeVariants": null,
"productionChannel": "string",
"vendor": "string",
"dueDate": "2019-08-24T14:15:22Z",
"poHumanId": "string",
"projectCode": "string",
"compositeSelectedQuantities": [{"id": "string",
"quantity": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeSelectedProducts": [{"id": "string",
"product": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeDesignTemplates": [{"id": "string",
"designTemplate": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designJobInitialNoteContent": "string",
"designJobInitialNoteAttachments": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"subtotal": 0,
"airCargoAmount": 0,
"shipping": 0,
"shippingDiscount": 0,
"salesTax": 0,
"taxExShipping": 0,
"discount": 0,
"total": 0,
"isTaxCalcDisabled": false,
"isOrderApprovalRequired": false,
"shipTo": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"billTo": {"companyName": "string",
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phoneNumber": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"blindShipFrom": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"availableShippingMethods": [null
],
"shipOutAddressInputMethod": "open",
"isCartAddressBookEnabled": false,
"isUseRecentAddressEnabled": false,
"isCostCenterInputEnabled": false,
"isPOInputEnabled": false,
"shipFromControl": false,
"showShippingRates": true,
"availableShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"deliveryDays": 0,
"deliveryDate": "2019-08-24T14:15:22Z",
"deliveryDateGuaranteed": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"staticShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"deliveryDays": 0,
"deliveryDate": "2019-08-24T14:15:22Z",
"deliveryDateGuaranteed": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"selectedShippingMethod": "string",
"selectedShippingService": "string",
"selectedShippingRate": "string",
"selectedAirportCode": "string",
"selectedPickupLocation": "string",
"appliedPromo": "string",
"appliedPromoCode": "string",
"appliedPromoCodeDescription": "string",
"order": "string",
"invoice": "string",
"convertedToOrder": false,
"microsite": "string",
"micrositeUser": "string",
"costCenter": "string",
"channel": "store-front",
"po": "string",
"foreignId": "string",
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"orderRef": "string",
"miscInfo": "string",
"arriveBy": "string",
"notification": [{"recipientName": "string",
"recipientAccount": "string",
"notificationType": "order-confirmation",
"deliveryStrategy": "email",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"shipmentPayment": {"type": "SENDER",
"account": "string",
"countryCode": "string",
"postalCode": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"easypostCarrierAccounts": ["string"
],
"additionalRecipients": [{"email": "string",
"name": "string",
"type": "to",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerSuppliedPackingSlip": "string",
"intakeChannel": "string",
"notificationPreference": "email",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of carts to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/cart/%7B_id%7D

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"salesPerson": "string",
"items": [{"product": "string",
"category": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"typeName": "string",
"typeKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"fromCompositeProduct": "string",
"fromCompositeQuantity": null,
"variantValues": [{"type": "string",
"value": "string",
"typeName": "string",
"typeKey": "string",
"valueName": "string",
"valueKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isCustom": false,
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"description": "string",
"price": 0,
"priceOverride": true,
"tax": 0,
"priceWithTax": 0,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"packageDims": {"width": 0,
"height": 0,
"length": 0,
"units": "string"
},
"unitType": "inch",
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnTotal": 0,
"staticName": "string",
"isPriority": false,
"images": [{"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplate": "string",
"designTemplateSecondary": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplateFieldset": "string",
"designTemplateRenderContext": null,
"renderToken": "string",
"artworkVariantValues": [{"type": "string",
"value": "string",
"artwork": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"artwork": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customFields": [{"type": "text",
"key": "string",
"label": "string",
"options": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isDigitalDelivery": false,
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"miscUploads": ["string"
],
"initialStatus": "string",
"triggerOrderApproval": true,
"discount": 0,
"compositeVariants": null,
"productionChannel": "string",
"vendor": "string",
"dueDate": "2019-08-24T14:15:22Z",
"poHumanId": "string",
"projectCode": "string",
"compositeSelectedQuantities": [{"id": "string",
"quantity": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeSelectedProducts": [{"id": "string",
"product": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeDesignTemplates": [{"id": "string",
"designTemplate": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designJobInitialNoteContent": "string",
"designJobInitialNoteAttachments": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"subtotal": 0,
"airCargoAmount": 0,
"shipping": 0,
"shippingDiscount": 0,
"salesTax": 0,
"taxExShipping": 0,
"discount": 0,
"total": 0,
"isTaxCalcDisabled": false,
"isOrderApprovalRequired": false,
"shipTo": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"billTo": {"companyName": "string",
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phoneNumber": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"blindShipFrom": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"availableShippingMethods": [null
],
"shipOutAddressInputMethod": "open",
"isCartAddressBookEnabled": false,
"isUseRecentAddressEnabled": false,
"isCostCenterInputEnabled": false,
"isPOInputEnabled": false,
"shipFromControl": false,
"showShippingRates": true,
"availableShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"deliveryDays": 0,
"deliveryDate": "2019-08-24T14:15:22Z",
"deliveryDateGuaranteed": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"staticShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"deliveryDays": 0,
"deliveryDate": "2019-08-24T14:15:22Z",
"deliveryDateGuaranteed": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"selectedShippingMethod": "string",
"selectedShippingService": "string",
"selectedShippingRate": "string",
"selectedAirportCode": "string",
"selectedPickupLocation": "string",
"appliedPromo": "string",
"appliedPromoCode": "string",
"appliedPromoCodeDescription": "string",
"order": "string",
"invoice": "string",
"convertedToOrder": false,
"microsite": "string",
"micrositeUser": "string",
"costCenter": "string",
"channel": "store-front",
"po": "string",
"foreignId": "string",
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"orderRef": "string",
"miscInfo": "string",
"arriveBy": "string",
"notification": [{"recipientName": "string",
"recipientAccount": "string",
"notificationType": "order-confirmation",
"deliveryStrategy": "email",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"shipmentPayment": {"type": "SENDER",
"account": "string",
"countryCode": "string",
"postalCode": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"easypostCarrierAccounts": ["string"
],
"additionalRecipients": [{"email": "string",
"name": "string",
"type": "to",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerSuppliedPackingSlip": "string",
"intakeChannel": "string",
"notificationPreference": "email",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of carts to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer	string^[0-9a-fA-F]{24}$ Refers to customers
salesPerson	string^[0-9a-fA-F]{24}$ Refers to salesPeople
	Array of objects (itemOf_items)
subtotal	number Default: 0
airCargoAmount	number
shipping	number Default: 0
shippingDiscount	number Default: 0
salesTax	number Default: 0
taxExShipping	number Default: 0
discount	number Default: 0
total	number Default: 0
isTaxCalcDisabled	boolean Default: false
isOrderApprovalRequired	boolean Default: false
	object (shipTo)
	object (billTo)
	object (blindShipFrom)
availableShippingMethods	Array of any
shipOutAddressInputMethod	string Default: "open" Enum: "open" "address-book" "read-only"
isCartAddressBookEnabled	boolean Default: false
isUseRecentAddressEnabled	boolean Default: false
isCostCenterInputEnabled	boolean Default: false
isPOInputEnabled	boolean Default: false
shipFromControl	boolean Default: false
showShippingRates	boolean Default: true
	Array of objects (itemOf_availableShippingRates)
	Array of objects (itemOf_staticShippingRates)
selectedShippingMethod	string
selectedShippingService	string
selectedShippingRate	string
selectedAirportCode	string
selectedPickupLocation	string^[0-9a-fA-F]{24}$ Refers to pickupLocations
appliedPromo	string^[0-9a-fA-F]{24}$ Refers to promoCodes
appliedPromoCode	string
appliedPromoCodeDescription	string
order	string^[0-9a-fA-F]{24}$ Refers to orders
invoice	string^[0-9a-fA-F]{24}$ Refers to invoices
convertedToOrder	boolean Default: false
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
micrositeUser	string^[0-9a-fA-F]{24}$ Refers to micrositeCustomers
costCenter	string
channel	string Enum: "store-front" "dashboard" "api" "custom-quote"
po	string
foreignId	string
	Array of objects (itemOf_metadata)
orderRef	string
miscInfo	string
arriveBy	string
	Array of objects (itemOf_notification)
	object (shipmentPayment)
easypostCarrierAccounts	Array of strings
	Array of objects (itemOf_additionalRecipients)
customerSuppliedPackingSlip	string^[0-9a-fA-F]{24}$ Refers to uploadLog
intakeChannel	string^[0-9a-fA-F]{24}$ Refers to intakeChannels
notificationPreference	string Default: "email" Enum: "email" "sms"
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"customer": "string",
"salesPerson": "string",
"items": [{"product": "string",
"category": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"typeName": "string",
"typeKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"fromCompositeProduct": "string",
"fromCompositeQuantity": null,
"variantValues": [{"type": "string",
"value": "string",
"typeName": "string",
"typeKey": "string",
"valueName": "string",
"valueKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isCustom": false,
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"description": "string",
"price": 0,
"priceOverride": true,
"tax": 0,
"priceWithTax": 0,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"packageDims": {"width": 0,
"height": 0,
"length": 0,
"units": "string"
},
"unitType": "inch",
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnTotal": 0,
"staticName": "string",
"isPriority": false,
"images": [{"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplate": "string",
"designTemplateSecondary": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplateFieldset": "string",
"designTemplateRenderContext": null,
"renderToken": "string",
"artworkVariantValues": [{"type": "string",
"value": "string",
"artwork": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"artwork": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customFields": [{"type": "text",
"key": "string",
"label": "string",
"options": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isDigitalDelivery": false,
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"miscUploads": ["string"
],
"initialStatus": "string",
"triggerOrderApproval": true,
"discount": 0,
"compositeVariants": null,
"productionChannel": "string",
"vendor": "string",
"dueDate": "2019-08-24T14:15:22Z",
"poHumanId": "string",
"projectCode": "string",
"compositeSelectedQuantities": [{"id": "string",
"quantity": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeSelectedProducts": [{"id": "string",
"product": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeDesignTemplates": [{"id": "string",
"designTemplate": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designJobInitialNoteContent": "string",
"designJobInitialNoteAttachments": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"subtotal": 0,
"airCargoAmount": 0,
"shipping": 0,
"shippingDiscount": 0,
"salesTax": 0,
"taxExShipping": 0,
"discount": 0,
"total": 0,
"isTaxCalcDisabled": false,
"isOrderApprovalRequired": false,
"shipTo": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"billTo": {"companyName": "string",
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phoneNumber": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"blindShipFrom": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"availableShippingMethods": [null
],
"shipOutAddressInputMethod": "open",
"isCartAddressBookEnabled": false,
"isUseRecentAddressEnabled": false,
"isCostCenterInputEnabled": false,
"isPOInputEnabled": false,
"shipFromControl": false,
"showShippingRates": true,
"availableShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"deliveryDays": 0,
"deliveryDate": "2019-08-24T14:15:22Z",
"deliveryDateGuaranteed": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"staticShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"deliveryDays": 0,
"deliveryDate": "2019-08-24T14:15:22Z",
"deliveryDateGuaranteed": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"selectedShippingMethod": "string",
"selectedShippingService": "string",
"selectedShippingRate": "string",
"selectedAirportCode": "string",
"selectedPickupLocation": "string",
"appliedPromo": "string",
"appliedPromoCode": "string",
"appliedPromoCodeDescription": "string",
"order": "string",
"invoice": "string",
"convertedToOrder": false,
"microsite": "string",
"micrositeUser": "string",
"costCenter": "string",
"channel": "store-front",
"po": "string",
"foreignId": "string",
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"orderRef": "string",
"miscInfo": "string",
"arriveBy": "string",
"notification": [{"recipientName": "string",
"recipientAccount": "string",
"notificationType": "order-confirmation",
"deliveryStrategy": "email",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"shipmentPayment": {"type": "SENDER",
"account": "string",
"countryCode": "string",
"postalCode": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"easypostCarrierAccounts": ["string"
],
"additionalRecipients": [{"email": "string",
"name": "string",
"type": "to",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerSuppliedPackingSlip": "string",
"intakeChannel": "string",
"notificationPreference": "email",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"salesPerson": "string",
"items": [{"product": "string",
"category": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"typeName": "string",
"typeKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"fromCompositeProduct": "string",
"fromCompositeQuantity": null,
"variantValues": [{"type": "string",
"value": "string",
"typeName": "string",
"typeKey": "string",
"valueName": "string",
"valueKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isCustom": false,
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"description": "string",
"price": 0,
"priceOverride": true,
"tax": 0,
"priceWithTax": 0,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"packageDims": {"width": 0,
"height": 0,
"length": 0,
"units": "string"
},
"unitType": "inch",
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnTotal": 0,
"staticName": "string",
"isPriority": false,
"images": [{"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplate": "string",
"designTemplateSecondary": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplateFieldset": "string",
"designTemplateRenderContext": null,
"renderToken": "string",
"artworkVariantValues": [{"type": "string",
"value": "string",
"artwork": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"artwork": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customFields": [{"type": "text",
"key": "string",
"label": "string",
"options": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isDigitalDelivery": false,
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"miscUploads": ["string"
],
"initialStatus": "string",
"triggerOrderApproval": true,
"discount": 0,
"compositeVariants": null,
"productionChannel": "string",
"vendor": "string",
"dueDate": "2019-08-24T14:15:22Z",
"poHumanId": "string",
"projectCode": "string",
"compositeSelectedQuantities": [{"id": "string",
"quantity": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeSelectedProducts": [{"id": "string",
"product": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeDesignTemplates": [{"id": "string",
"designTemplate": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designJobInitialNoteContent": "string",
"designJobInitialNoteAttachments": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"subtotal": 0,
"airCargoAmount": 0,
"shipping": 0,
"shippingDiscount": 0,
"salesTax": 0,
"taxExShipping": 0,
"discount": 0,
"total": 0,
"isTaxCalcDisabled": false,
"isOrderApprovalRequired": false,
"shipTo": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"billTo": {"companyName": "string",
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phoneNumber": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"blindShipFrom": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"availableShippingMethods": [null
],
"shipOutAddressInputMethod": "open",
"isCartAddressBookEnabled": false,
"isUseRecentAddressEnabled": false,
"isCostCenterInputEnabled": false,
"isPOInputEnabled": false,
"shipFromControl": false,
"showShippingRates": true,
"availableShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"deliveryDays": 0,
"deliveryDate": "2019-08-24T14:15:22Z",
"deliveryDateGuaranteed": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"staticShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"deliveryDays": 0,
"deliveryDate": "2019-08-24T14:15:22Z",
"deliveryDateGuaranteed": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"selectedShippingMethod": "string",
"selectedShippingService": "string",
"selectedShippingRate": "string",
"selectedAirportCode": "string",
"selectedPickupLocation": "string",
"appliedPromo": "string",
"appliedPromoCode": "string",
"appliedPromoCodeDescription": "string",
"order": "string",
"invoice": "string",
"convertedToOrder": false,
"microsite": "string",
"micrositeUser": "string",
"costCenter": "string",
"channel": "store-front",
"po": "string",
"foreignId": "string",
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"orderRef": "string",
"miscInfo": "string",
"arriveBy": "string",
"notification": [{"recipientName": "string",
"recipientAccount": "string",
"notificationType": "order-confirmation",
"deliveryStrategy": "email",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"shipmentPayment": {"type": "SENDER",
"account": "string",
"countryCode": "string",
"postalCode": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"easypostCarrierAccounts": ["string"
],
"additionalRecipients": [{"email": "string",
"name": "string",
"type": "to",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerSuppliedPackingSlip": "string",
"intakeChannel": "string",
"notificationPreference": "email",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of carts to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer	string^[0-9a-fA-F]{24}$ Refers to customers
salesPerson	string^[0-9a-fA-F]{24}$ Refers to salesPeople
	Array of objects (itemOf_items)
subtotal	number Default: 0
airCargoAmount	number
shipping	number Default: 0
shippingDiscount	number Default: 0
salesTax	number Default: 0
taxExShipping	number Default: 0
discount	number Default: 0
total	number Default: 0
isTaxCalcDisabled	boolean Default: false
isOrderApprovalRequired	boolean Default: false
	object (shipTo)
	object (billTo)
	object (blindShipFrom)
availableShippingMethods	Array of any
shipOutAddressInputMethod	string Default: "open" Enum: "open" "address-book" "read-only"
isCartAddressBookEnabled	boolean Default: false
isUseRecentAddressEnabled	boolean Default: false
isCostCenterInputEnabled	boolean Default: false
isPOInputEnabled	boolean Default: false
shipFromControl	boolean Default: false
showShippingRates	boolean Default: true
	Array of objects (itemOf_availableShippingRates)
	Array of objects (itemOf_staticShippingRates)
selectedShippingMethod	string
selectedShippingService	string
selectedShippingRate	string
selectedAirportCode	string
selectedPickupLocation	string^[0-9a-fA-F]{24}$ Refers to pickupLocations
appliedPromo	string^[0-9a-fA-F]{24}$ Refers to promoCodes
appliedPromoCode	string
appliedPromoCodeDescription	string
order	string^[0-9a-fA-F]{24}$ Refers to orders
invoice	string^[0-9a-fA-F]{24}$ Refers to invoices
convertedToOrder	boolean Default: false
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
micrositeUser	string^[0-9a-fA-F]{24}$ Refers to micrositeCustomers
costCenter	string
channel	string Enum: "store-front" "dashboard" "api" "custom-quote"
po	string
foreignId	string
	Array of objects (itemOf_metadata)
orderRef	string
miscInfo	string
arriveBy	string
	Array of objects (itemOf_notification)
	object (shipmentPayment)
easypostCarrierAccounts	Array of strings
	Array of objects (itemOf_additionalRecipients)
customerSuppliedPackingSlip	string^[0-9a-fA-F]{24}$ Refers to uploadLog
intakeChannel	string^[0-9a-fA-F]{24}$ Refers to intakeChannels
notificationPreference	string Default: "email" Enum: "email" "sms"
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"tenant": "string",
"customer": "string",
"salesPerson": "string",
"items": [{"product": "string",
"category": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"typeName": "string",
"typeKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"fromCompositeProduct": "string",
"fromCompositeQuantity": null,
"variantValues": [{"type": "string",
"value": "string",
"typeName": "string",
"typeKey": "string",
"valueName": "string",
"valueKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isCustom": false,
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"description": "string",
"price": 0,
"priceOverride": true,
"tax": 0,
"priceWithTax": 0,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"packageDims": {"width": 0,
"height": 0,
"length": 0,
"units": "string"
},
"unitType": "inch",
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnTotal": 0,
"staticName": "string",
"isPriority": false,
"images": [{"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplate": "string",
"designTemplateSecondary": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplateFieldset": "string",
"designTemplateRenderContext": null,
"renderToken": "string",
"artworkVariantValues": [{"type": "string",
"value": "string",
"artwork": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"artwork": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customFields": [{"type": "text",
"key": "string",
"label": "string",
"options": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isDigitalDelivery": false,
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"miscUploads": ["string"
],
"initialStatus": "string",
"triggerOrderApproval": true,
"discount": 0,
"compositeVariants": null,
"productionChannel": "string",
"vendor": "string",
"dueDate": "2019-08-24T14:15:22Z",
"poHumanId": "string",
"projectCode": "string",
"compositeSelectedQuantities": [{"id": "string",
"quantity": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeSelectedProducts": [{"id": "string",
"product": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeDesignTemplates": [{"id": "string",
"designTemplate": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designJobInitialNoteContent": "string",
"designJobInitialNoteAttachments": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"subtotal": 0,
"airCargoAmount": 0,
"shipping": 0,
"shippingDiscount": 0,
"salesTax": 0,
"taxExShipping": 0,
"discount": 0,
"total": 0,
"isTaxCalcDisabled": false,
"isOrderApprovalRequired": false,
"shipTo": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"billTo": {"companyName": "string",
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phoneNumber": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"blindShipFrom": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"availableShippingMethods": [null
],
"shipOutAddressInputMethod": "open",
"isCartAddressBookEnabled": false,
"isUseRecentAddressEnabled": false,
"isCostCenterInputEnabled": false,
"isPOInputEnabled": false,
"shipFromControl": false,
"showShippingRates": true,
"availableShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"deliveryDays": 0,
"deliveryDate": "2019-08-24T14:15:22Z",
"deliveryDateGuaranteed": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"staticShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"deliveryDays": 0,
"deliveryDate": "2019-08-24T14:15:22Z",
"deliveryDateGuaranteed": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"selectedShippingMethod": "string",
"selectedShippingService": "string",
"selectedShippingRate": "string",
"selectedAirportCode": "string",
"selectedPickupLocation": "string",
"appliedPromo": "string",
"appliedPromoCode": "string",
"appliedPromoCodeDescription": "string",
"order": "string",
"invoice": "string",
"convertedToOrder": false,
"microsite": "string",
"micrositeUser": "string",
"costCenter": "string",
"channel": "store-front",
"po": "string",
"foreignId": "string",
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"orderRef": "string",
"miscInfo": "string",
"arriveBy": "string",
"notification": [{"recipientName": "string",
"recipientAccount": "string",
"notificationType": "order-confirmation",
"deliveryStrategy": "email",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"shipmentPayment": {"type": "SENDER",
"account": "string",
"countryCode": "string",
"postalCode": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"easypostCarrierAccounts": ["string"
],
"additionalRecipients": [{"email": "string",
"name": "string",
"type": "to",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerSuppliedPackingSlip": "string",
"intakeChannel": "string",
"notificationPreference": "email",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"salesPerson": "string",
"items": [{"product": "string",
"category": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"typeName": "string",
"typeKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"fromCompositeProduct": "string",
"fromCompositeQuantity": null,
"variantValues": [{"type": "string",
"value": "string",
"typeName": "string",
"typeKey": "string",
"valueName": "string",
"valueKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isCustom": false,
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"description": "string",
"price": 0,
"priceOverride": true,
"tax": 0,
"priceWithTax": 0,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"packageDims": {"width": 0,
"height": 0,
"length": 0,
"units": "string"
},
"unitType": "inch",
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnTotal": 0,
"staticName": "string",
"isPriority": false,
"images": [{"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplate": "string",
"designTemplateSecondary": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplateFieldset": "string",
"designTemplateRenderContext": null,
"renderToken": "string",
"artworkVariantValues": [{"type": "string",
"value": "string",
"artwork": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"artwork": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customFields": [{"type": "text",
"key": "string",
"label": "string",
"options": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isDigitalDelivery": false,
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"miscUploads": ["string"
],
"initialStatus": "string",
"triggerOrderApproval": true,
"discount": 0,
"compositeVariants": null,
"productionChannel": "string",
"vendor": "string",
"dueDate": "2019-08-24T14:15:22Z",
"poHumanId": "string",
"projectCode": "string",
"compositeSelectedQuantities": [{"id": "string",
"quantity": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeSelectedProducts": [{"id": "string",
"product": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeDesignTemplates": [{"id": "string",
"designTemplate": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designJobInitialNoteContent": "string",
"designJobInitialNoteAttachments": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"subtotal": 0,
"airCargoAmount": 0,
"shipping": 0,
"shippingDiscount": 0,
"salesTax": 0,
"taxExShipping": 0,
"discount": 0,
"total": 0,
"isTaxCalcDisabled": false,
"isOrderApprovalRequired": false,
"shipTo": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"billTo": {"companyName": "string",
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phoneNumber": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"blindShipFrom": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"availableShippingMethods": [null
],
"shipOutAddressInputMethod": "open",
"isCartAddressBookEnabled": false,
"isUseRecentAddressEnabled": false,
"isCostCenterInputEnabled": false,
"isPOInputEnabled": false,
"shipFromControl": false,
"showShippingRates": true,
"availableShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"deliveryDays": 0,
"deliveryDate": "2019-08-24T14:15:22Z",
"deliveryDateGuaranteed": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"staticShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"deliveryDays": 0,
"deliveryDate": "2019-08-24T14:15:22Z",
"deliveryDateGuaranteed": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"selectedShippingMethod": "string",
"selectedShippingService": "string",
"selectedShippingRate": "string",
"selectedAirportCode": "string",
"selectedPickupLocation": "string",
"appliedPromo": "string",
"appliedPromoCode": "string",
"appliedPromoCodeDescription": "string",
"order": "string",
"invoice": "string",
"convertedToOrder": false,
"microsite": "string",
"micrositeUser": "string",
"costCenter": "string",
"channel": "store-front",
"po": "string",
"foreignId": "string",
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"orderRef": "string",
"miscInfo": "string",
"arriveBy": "string",
"notification": [{"recipientName": "string",
"recipientAccount": "string",
"notificationType": "order-confirmation",
"deliveryStrategy": "email",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"shipmentPayment": {"type": "SENDER",
"account": "string",
"countryCode": "string",
"postalCode": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"easypostCarrierAccounts": ["string"
],
"additionalRecipients": [{"email": "string",
"name": "string",
"type": "to",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerSuppliedPackingSlip": "string",
"intakeChannel": "string",
"notificationPreference": "email",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of carts to remove

Responses

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"salesPerson": "string",
"items": [{"product": "string",
"category": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"typeName": "string",
"typeKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"fromCompositeProduct": "string",
"fromCompositeQuantity": null,
"variantValues": [{"type": "string",
"value": "string",
"typeName": "string",
"typeKey": "string",
"valueName": "string",
"valueKey": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isCustom": false,
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"description": "string",
"price": 0,
"priceOverride": true,
"tax": 0,
"priceWithTax": 0,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"packageDims": {"width": 0,
"height": 0,
"length": 0,
"units": "string"
},
"unitType": "inch",
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnTotal": 0,
"staticName": "string",
"isPriority": false,
"images": [{"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplate": "string",
"designTemplateSecondary": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designTemplateFieldset": "string",
"designTemplateRenderContext": null,
"renderToken": "string",
"artworkVariantValues": [{"type": "string",
"value": "string",
"artwork": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"artwork": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customFields": [{"type": "text",
"key": "string",
"label": "string",
"options": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"isDigitalDelivery": false,
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"miscUploads": ["string"
],
"initialStatus": "string",
"triggerOrderApproval": true,
"discount": 0,
"compositeVariants": null,
"productionChannel": "string",
"vendor": "string",
"dueDate": "2019-08-24T14:15:22Z",
"poHumanId": "string",
"projectCode": "string",
"compositeSelectedQuantities": [{"id": "string",
"quantity": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeSelectedProducts": [{"id": "string",
"product": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"compositeDesignTemplates": [{"id": "string",
"designTemplate": "string",
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"designJobInitialNoteContent": "string",
"designJobInitialNoteAttachments": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"subtotal": 0,
"airCargoAmount": 0,
"shipping": 0,
"shippingDiscount": 0,
"salesTax": 0,
"taxExShipping": 0,
"discount": 0,
"total": 0,
"isTaxCalcDisabled": false,
"isOrderApprovalRequired": false,
"shipTo": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"billTo": {"companyName": "string",
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phoneNumber": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"blindShipFrom": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"phone": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"availableShippingMethods": [null
],
"shipOutAddressInputMethod": "open",
"isCartAddressBookEnabled": false,
"isUseRecentAddressEnabled": false,
"isCostCenterInputEnabled": false,
"isPOInputEnabled": false,
"shipFromControl": false,
"showShippingRates": true,
"availableShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"deliveryDays": 0,
"deliveryDate": "2019-08-24T14:15:22Z",
"deliveryDateGuaranteed": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"staticShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"deliveryDays": 0,
"deliveryDate": "2019-08-24T14:15:22Z",
"deliveryDateGuaranteed": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"selectedShippingMethod": "string",
"selectedShippingService": "string",
"selectedShippingRate": "string",
"selectedAirportCode": "string",
"selectedPickupLocation": "string",
"appliedPromo": "string",
"appliedPromoCode": "string",
"appliedPromoCodeDescription": "string",
"order": "string",
"invoice": "string",
"convertedToOrder": false,
"microsite": "string",
"micrositeUser": "string",
"costCenter": "string",
"channel": "store-front",
"po": "string",
"foreignId": "string",
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"orderRef": "string",
"miscInfo": "string",
"arriveBy": "string",
"notification": [{"recipientName": "string",
"recipientAccount": "string",
"notificationType": "order-confirmation",
"deliveryStrategy": "email",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"shipmentPayment": {"type": "SENDER",
"account": "string",
"countryCode": "string",
"postalCode": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"easypostCarrierAccounts": ["string"
],
"additionalRecipients": [{"email": "string",
"name": "string",
"type": "to",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerSuppliedPackingSlip": "string",
"intakeChannel": "string",
"notificationPreference": "email",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

certificate-code

A certificate-code service

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (certificate-code) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/certificate-code?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"tenant": "string",
"microsite": "string",
"code": "string",
"isUsed": false,
"isResend": true,
"order": "string",
"orderItem": "string",
"dateUsed": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
code required	string
isUsed	boolean Default: false
isResend	boolean
order	string^[0-9a-fA-F]{24}$ Refers to orders
orderItem	string^[0-9a-fA-F]{24}$ Refers to orderItems
dateUsed	string <date-time>
createdAt	string <date-time>
updatedAt	string <date-time>
_id	string^[0-9a-fA-F]{24}$
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"microsite": "string",
"code": "string",
"isUsed": false,
"isResend": true,
"order": "string",
"orderItem": "string",
"dateUsed": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"__v": 0
}

Response samples

201

Content type

application/json

{"tenant": "string",
"microsite": "string",
"code": "string",
"isUsed": false,
"isResend": true,
"order": "string",
"orderItem": "string",
"dateUsed": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of certificate-code to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/certificate-code/%7B_id%7D

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"code": "string",
"isUsed": false,
"isResend": true,
"order": "string",
"orderItem": "string",
"dateUsed": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of certificate-code to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
code required	string
isUsed	boolean Default: false
isResend	boolean
order	string^[0-9a-fA-F]{24}$ Refers to orders
orderItem	string^[0-9a-fA-F]{24}$ Refers to orderItems
dateUsed	string <date-time>
createdAt	string <date-time>
updatedAt	string <date-time>
_id	string^[0-9a-fA-F]{24}$
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"microsite": "string",
"code": "string",
"isUsed": false,
"isResend": true,
"order": "string",
"orderItem": "string",
"dateUsed": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"code": "string",
"isUsed": false,
"isResend": true,
"order": "string",
"orderItem": "string",
"dateUsed": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of certificate-code to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
code required	string
isUsed	boolean Default: false
isResend	boolean
order	string^[0-9a-fA-F]{24}$ Refers to orders
orderItem	string^[0-9a-fA-F]{24}$ Refers to orderItems
dateUsed	string <date-time>
createdAt	string <date-time>
updatedAt	string <date-time>
_id	string^[0-9a-fA-F]{24}$
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"tenant": "string",
"microsite": "string",
"code": "string",
"isUsed": false,
"isResend": true,
"order": "string",
"orderItem": "string",
"dateUsed": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"code": "string",
"isUsed": false,
"isResend": true,
"order": "string",
"orderItem": "string",
"dateUsed": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of certificate-code to remove

Responses

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"code": "string",
"isUsed": false,
"isResend": true,
"order": "string",
"orderItem": "string",
"dateUsed": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"__v": 0
}

chat-transcripts

A chat-transcripts service

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (ChatlioTranscript) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/chat-transcripts?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"business": "string",
"agentEmail": "string",
"agentName": "string",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"visitorEmail": "string",
"visitorName": "string",
"replyToEmail": "string",
"messages": "string",
"chatMessages": [{"text": "string",
"ts": "string",
"sentAt": "2019-08-24T14:15:22Z",
"userId": "string",
"username": "string",
"isVisitorMsg": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

business	string^[0-9a-fA-F]{24}$ Refers to tenants
agentEmail required	string
agentName required	string
startedAt	string <date-time>
endedAt	string <date-time>
visitorEmail	string
visitorName required	string
replyToEmail	string
messages required	string
	Array of objects (itemOf_chatMessages)
customer	string^[0-9a-fA-F]{24}$ Refers to customers
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"business": "string",
"agentEmail": "string",
"agentName": "string",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"visitorEmail": "string",
"visitorName": "string",
"replyToEmail": "string",
"messages": "string",
"chatMessages": [{"text": "string",
"ts": "string",
"sentAt": "2019-08-24T14:15:22Z",
"userId": "string",
"username": "string",
"isVisitorMsg": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

{"business": "string",
"agentEmail": "string",
"agentName": "string",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"visitorEmail": "string",
"visitorName": "string",
"replyToEmail": "string",
"messages": "string",
"chatMessages": [{"text": "string",
"ts": "string",
"sentAt": "2019-08-24T14:15:22Z",
"userId": "string",
"username": "string",
"isVisitorMsg": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of ChatlioTranscript to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/chat-transcripts/%7B_id%7D

Response samples

200

Content type

application/json

{"business": "string",
"agentEmail": "string",
"agentName": "string",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"visitorEmail": "string",
"visitorName": "string",
"replyToEmail": "string",
"messages": "string",
"chatMessages": [{"text": "string",
"ts": "string",
"sentAt": "2019-08-24T14:15:22Z",
"userId": "string",
"username": "string",
"isVisitorMsg": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of ChatlioTranscript to update

Request Body schema: application/json

business	string^[0-9a-fA-F]{24}$ Refers to tenants
agentEmail required	string
agentName required	string
startedAt	string <date-time>
endedAt	string <date-time>
visitorEmail	string
visitorName required	string
replyToEmail	string
messages required	string
	Array of objects (itemOf_chatMessages)
customer	string^[0-9a-fA-F]{24}$ Refers to customers
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"business": "string",
"agentEmail": "string",
"agentName": "string",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"visitorEmail": "string",
"visitorName": "string",
"replyToEmail": "string",
"messages": "string",
"chatMessages": [{"text": "string",
"ts": "string",
"sentAt": "2019-08-24T14:15:22Z",
"userId": "string",
"username": "string",
"isVisitorMsg": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"business": "string",
"agentEmail": "string",
"agentName": "string",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"visitorEmail": "string",
"visitorName": "string",
"replyToEmail": "string",
"messages": "string",
"chatMessages": [{"text": "string",
"ts": "string",
"sentAt": "2019-08-24T14:15:22Z",
"userId": "string",
"username": "string",
"isVisitorMsg": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of ChatlioTranscript to update

Request Body schema: application/json

business	string^[0-9a-fA-F]{24}$ Refers to tenants
agentEmail required	string
agentName required	string
startedAt	string <date-time>
endedAt	string <date-time>
visitorEmail	string
visitorName required	string
replyToEmail	string
messages required	string
	Array of objects (itemOf_chatMessages)
customer	string^[0-9a-fA-F]{24}$ Refers to customers
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"business": "string",
"agentEmail": "string",
"agentName": "string",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"visitorEmail": "string",
"visitorName": "string",
"replyToEmail": "string",
"messages": "string",
"chatMessages": [{"text": "string",
"ts": "string",
"sentAt": "2019-08-24T14:15:22Z",
"userId": "string",
"username": "string",
"isVisitorMsg": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"business": "string",
"agentEmail": "string",
"agentName": "string",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"visitorEmail": "string",
"visitorName": "string",
"replyToEmail": "string",
"messages": "string",
"chatMessages": [{"text": "string",
"ts": "string",
"sentAt": "2019-08-24T14:15:22Z",
"userId": "string",
"username": "string",
"isVisitorMsg": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of ChatlioTranscript to remove

Responses

Response samples

200

Content type

application/json

{"business": "string",
"agentEmail": "string",
"agentName": "string",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"visitorEmail": "string",
"visitorName": "string",
"replyToEmail": "string",
"messages": "string",
"chatMessages": [{"text": "string",
"ts": "string",
"sentAt": "2019-08-24T14:15:22Z",
"userId": "string",
"username": "string",
"isVisitorMsg": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

clear-cache

A clear-cache service

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
filter	object (fulfillment-staging-locations/staged) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/clear-cache/calculator?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

[{ }
]

client-tokens

A client-tokens service

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (ClientToken) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/client-tokens?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"tenant": "string",
"microsite": "string",
"token": "string",
"createdBy": "string",
"createdByModel": "user",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite required	string^[0-9a-fA-F]{24}$ Refers to tenants
token required	string
createdBy	string^[0-9a-fA-F]{24}$
createdByModel	string Enum: "user" "commandCenterUser" "micrositeCustomers"
deleted	boolean Default: false
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"microsite": "string",
"token": "string",
"createdBy": "string",
"createdByModel": "user",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

{"tenant": "string",
"microsite": "string",
"token": "string",
"createdBy": "string",
"createdByModel": "user",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of ClientToken to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/client-tokens/%7B_id%7D

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"token": "string",
"createdBy": "string",
"createdByModel": "user",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of ClientToken to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite required	string^[0-9a-fA-F]{24}$ Refers to tenants
token required	string
createdBy	string^[0-9a-fA-F]{24}$
createdByModel	string Enum: "user" "commandCenterUser" "micrositeCustomers"
deleted	boolean Default: false
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"microsite": "string",
"token": "string",
"createdBy": "string",
"createdByModel": "user",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"token": "string",
"createdBy": "string",
"createdByModel": "user",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of ClientToken to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite required	string^[0-9a-fA-F]{24}$ Refers to tenants
token required	string
createdBy	string^[0-9a-fA-F]{24}$
createdByModel	string Enum: "user" "commandCenterUser" "micrositeCustomers"
deleted	boolean Default: false
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"tenant": "string",
"microsite": "string",
"token": "string",
"createdBy": "string",
"createdByModel": "user",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"token": "string",
"createdBy": "string",
"createdByModel": "user",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of ClientToken to remove

Responses

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"token": "string",
"createdBy": "string",
"createdByModel": "user",
"deleted": false,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

connected-clients

A connected-clients service

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (connectedClients) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/connected-clients?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"tenant": "string",
"fingerprintId": "string",
"authedUser": "string",
"authedUserModel": "user",
"isAuthed": false,
"isConnected": false,
"lastAuthedAt": "2019-08-24T14:15:22Z",
"lastConnectedAt": "2019-08-24T14:15:22Z",
"fingerprintData": {"platform": "string",
"release": "string",
"hostname": "string",
"homedir": "string",
"totalmem": "string",
"cpus": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

One of

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
fingerprintId	string
authedUser	string^[0-9a-fA-F]{24}$
authedUserModel	string Enum: "user" "commandCenterUser" "micrositeCustomers"
isAuthed	boolean Default: false
isConnected	boolean Default: false
lastAuthedAt	string <date-time>
lastConnectedAt	string <date-time>
	object (fingerprintData)
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

Example

connectedClients

{"tenant": "string",
"fingerprintId": "string",
"authedUser": "string",
"authedUserModel": "user",
"isAuthed": false,
"isConnected": false,
"lastAuthedAt": "2019-08-24T14:15:22Z",
"lastConnectedAt": "2019-08-24T14:15:22Z",
"fingerprintData": {"platform": "string",
"release": "string",
"hostname": "string",
"homedir": "string",
"totalmem": "string",
"cpus": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

Example

connectedClients

{"tenant": "string",
"fingerprintId": "string",
"authedUser": "string",
"authedUserModel": "user",
"isAuthed": false,
"isConnected": false,
"lastAuthedAt": "2019-08-24T14:15:22Z",
"lastConnectedAt": "2019-08-24T14:15:22Z",
"fingerprintData": {"platform": "string",
"release": "string",
"hostname": "string",
"homedir": "string",
"totalmem": "string",
"cpus": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates multiple resources.

Request Body schema: application/json

Array

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
fingerprintId	string
authedUser	string^[0-9a-fA-F]{24}$
authedUserModel	string Enum: "user" "commandCenterUser" "micrositeCustomers"
isAuthed	boolean Default: false
isConnected	boolean Default: false
lastAuthedAt	string <date-time>
lastConnectedAt	string <date-time>
	object (fingerprintData)
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

[{"tenant": "string",
"fingerprintId": "string",
"authedUser": "string",
"authedUserModel": "user",
"isAuthed": false,
"isConnected": false,
"lastAuthedAt": "2019-08-24T14:15:22Z",
"lastConnectedAt": "2019-08-24T14:15:22Z",
"fingerprintData": {"platform": "string",
"release": "string",
"hostname": "string",
"homedir": "string",
"totalmem": "string",
"cpus": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]

Response samples

200

Content type

application/json

[{"tenant": "string",
"fingerprintId": "string",
"authedUser": "string",
"authedUserModel": "user",
"isAuthed": false,
"isConnected": false,
"lastAuthedAt": "2019-08-24T14:15:22Z",
"lastConnectedAt": "2019-08-24T14:15:22Z",
"fingerprintData": {"platform": "string",
"release": "string",
"hostname": "string",
"homedir": "string",
"totalmem": "string",
"cpus": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]

Updates multiple resources queried by given filter

Updates multiple resources queried by given filters.

query Parameters

object (connectedClients)

Query parameters to filter

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
fingerprintId	string
authedUser	string^[0-9a-fA-F]{24}$
authedUserModel	string Enum: "user" "commandCenterUser" "micrositeCustomers"
isAuthed	boolean Default: false
isConnected	boolean Default: false
lastAuthedAt	string <date-time>
lastConnectedAt	string <date-time>
	object (fingerprintData)
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"tenant": "string",
"fingerprintId": "string",
"authedUser": "string",
"authedUserModel": "user",
"isAuthed": false,
"isConnected": false,
"lastAuthedAt": "2019-08-24T14:15:22Z",
"lastConnectedAt": "2019-08-24T14:15:22Z",
"fingerprintData": {"platform": "string",
"release": "string",
"hostname": "string",
"homedir": "string",
"totalmem": "string",
"cpus": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

[{"tenant": "string",
"fingerprintId": "string",
"authedUser": "string",
"authedUserModel": "user",
"isAuthed": false,
"isConnected": false,
"lastAuthedAt": "2019-08-24T14:15:22Z",
"lastConnectedAt": "2019-08-24T14:15:22Z",
"fingerprintData": {"platform": "string",
"release": "string",
"hostname": "string",
"homedir": "string",
"totalmem": "string",
"cpus": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]

Removes multiple resources queried by given filter

Removes multiple resources queried by given filters.

query Parameters

object (connectedClients)

Query parameters to filter

Responses

Response samples

200

Content type

application/json

[{"tenant": "string",
"fingerprintId": "string",
"authedUser": "string",
"authedUserModel": "user",
"isAuthed": false,
"isConnected": false,
"lastAuthedAt": "2019-08-24T14:15:22Z",
"lastConnectedAt": "2019-08-24T14:15:22Z",
"fingerprintData": {"platform": "string",
"release": "string",
"hostname": "string",
"homedir": "string",
"totalmem": "string",
"cpus": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of connectedClients to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/connected-clients/%7B_id%7D

Response samples

200

Content type

application/json

{"tenant": "string",
"fingerprintId": "string",
"authedUser": "string",
"authedUserModel": "user",
"isAuthed": false,
"isConnected": false,
"lastAuthedAt": "2019-08-24T14:15:22Z",
"lastConnectedAt": "2019-08-24T14:15:22Z",
"fingerprintData": {"platform": "string",
"release": "string",
"hostname": "string",
"homedir": "string",
"totalmem": "string",
"cpus": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of connectedClients to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
fingerprintId	string
authedUser	string^[0-9a-fA-F]{24}$
authedUserModel	string Enum: "user" "commandCenterUser" "micrositeCustomers"
isAuthed	boolean Default: false
isConnected	boolean Default: false
lastAuthedAt	string <date-time>
lastConnectedAt	string <date-time>
	object (fingerprintData)
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"fingerprintId": "string",
"authedUser": "string",
"authedUserModel": "user",
"isAuthed": false,
"isConnected": false,
"lastAuthedAt": "2019-08-24T14:15:22Z",
"lastConnectedAt": "2019-08-24T14:15:22Z",
"fingerprintData": {"platform": "string",
"release": "string",
"hostname": "string",
"homedir": "string",
"totalmem": "string",
"cpus": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"fingerprintId": "string",
"authedUser": "string",
"authedUserModel": "user",
"isAuthed": false,
"isConnected": false,
"lastAuthedAt": "2019-08-24T14:15:22Z",
"lastConnectedAt": "2019-08-24T14:15:22Z",
"fingerprintData": {"platform": "string",
"release": "string",
"hostname": "string",
"homedir": "string",
"totalmem": "string",
"cpus": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of connectedClients to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
fingerprintId	string
authedUser	string^[0-9a-fA-F]{24}$
authedUserModel	string Enum: "user" "commandCenterUser" "micrositeCustomers"
isAuthed	boolean Default: false
isConnected	boolean Default: false
lastAuthedAt	string <date-time>
lastConnectedAt	string <date-time>
	object (fingerprintData)
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"tenant": "string",
"fingerprintId": "string",
"authedUser": "string",
"authedUserModel": "user",
"isAuthed": false,
"isConnected": false,
"lastAuthedAt": "2019-08-24T14:15:22Z",
"lastConnectedAt": "2019-08-24T14:15:22Z",
"fingerprintData": {"platform": "string",
"release": "string",
"hostname": "string",
"homedir": "string",
"totalmem": "string",
"cpus": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"fingerprintId": "string",
"authedUser": "string",
"authedUserModel": "user",
"isAuthed": false,
"isConnected": false,
"lastAuthedAt": "2019-08-24T14:15:22Z",
"lastConnectedAt": "2019-08-24T14:15:22Z",
"fingerprintData": {"platform": "string",
"release": "string",
"hostname": "string",
"homedir": "string",
"totalmem": "string",
"cpus": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of connectedClients to remove

Responses

Response samples

200

Content type

application/json

{"tenant": "string",
"fingerprintId": "string",
"authedUser": "string",
"authedUserModel": "user",
"isAuthed": false,
"isConnected": false,
"lastAuthedAt": "2019-08-24T14:15:22Z",
"lastConnectedAt": "2019-08-24T14:15:22Z",
"fingerprintData": {"platform": "string",
"release": "string",
"hostname": "string",
"homedir": "string",
"totalmem": "string",
"cpus": ["string"
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

contact-us-entries

A contact-us-entries service

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (contactUsEntries) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/contact-us-entries?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"business": "string",
"name": "string",
"email": "string",
"message": "string",
"status": "open",
"customFields": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

business required	string^[0-9a-fA-F]{24}$ Refers to tenants
name required	string
email	string
message required	string
status	string Default: "open" Enum: "open" "closed"
	Array of objects (itemOf_customFields)
	Array of objects (itemOf_metadata)
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"business": "string",
"name": "string",
"email": "string",
"message": "string",
"status": "open",
"customFields": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

{"business": "string",
"name": "string",
"email": "string",
"message": "string",
"status": "open",
"customFields": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of contactUsEntries to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/contact-us-entries/%7B_id%7D

Response samples

200

Content type

application/json

{"business": "string",
"name": "string",
"email": "string",
"message": "string",
"status": "open",
"customFields": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of contactUsEntries to update

Request Body schema: application/json

business required	string^[0-9a-fA-F]{24}$ Refers to tenants
name required	string
email	string
message required	string
status	string Default: "open" Enum: "open" "closed"
	Array of objects (itemOf_customFields)
	Array of objects (itemOf_metadata)
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"business": "string",
"name": "string",
"email": "string",
"message": "string",
"status": "open",
"customFields": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"business": "string",
"name": "string",
"email": "string",
"message": "string",
"status": "open",
"customFields": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of contactUsEntries to update

Request Body schema: application/json

business required	string^[0-9a-fA-F]{24}$ Refers to tenants
name required	string
email	string
message required	string
status	string Default: "open" Enum: "open" "closed"
	Array of objects (itemOf_customFields)
	Array of objects (itemOf_metadata)
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"business": "string",
"name": "string",
"email": "string",
"message": "string",
"status": "open",
"customFields": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"business": "string",
"name": "string",
"email": "string",
"message": "string",
"status": "open",
"customFields": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of contactUsEntries to remove

Responses

Response samples

200

Content type

application/json

{"business": "string",
"name": "string",
"email": "string",
"message": "string",
"status": "open",
"customFields": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

content

A content service

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (Content) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/content?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"tenant": "string",
"microsite": "string",
"filename": "string",
"size": "string",
"mimeType": "string",
"extension": "string",
"publicUrl": "string",
"thumbUrl": "string",
"isThumbComplete": true,
"uploadLog": "string",
"createdAt": "2019-08-24T14:15:22Z",
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

tenant	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
filename required	string
size required	string
mimeType required	string
extension required	string
publicUrl	string
thumbUrl	string
isThumbComplete	boolean
uploadLog	string^[0-9a-fA-F]{24}$ Refers to uploadLog
createdAt	string <date-time>
_id	string^[0-9a-fA-F]{24}$
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"microsite": "string",
"filename": "string",
"size": "string",
"mimeType": "string",
"extension": "string",
"publicUrl": "string",
"thumbUrl": "string",
"isThumbComplete": true,
"uploadLog": "string",
"createdAt": "2019-08-24T14:15:22Z",
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

{"tenant": "string",
"microsite": "string",
"filename": "string",
"size": "string",
"mimeType": "string",
"extension": "string",
"publicUrl": "string",
"thumbUrl": "string",
"isThumbComplete": true,
"uploadLog": "string",
"createdAt": "2019-08-24T14:15:22Z",
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of Content to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/content/%7B_id%7D

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"filename": "string",
"size": "string",
"mimeType": "string",
"extension": "string",
"publicUrl": "string",
"thumbUrl": "string",
"isThumbComplete": true,
"uploadLog": "string",
"createdAt": "2019-08-24T14:15:22Z",
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of Content to update

Request Body schema: application/json

tenant	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
filename required	string
size required	string
mimeType required	string
extension required	string
publicUrl	string
thumbUrl	string
isThumbComplete	boolean
uploadLog	string^[0-9a-fA-F]{24}$ Refers to uploadLog
createdAt	string <date-time>
_id	string^[0-9a-fA-F]{24}$
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"microsite": "string",
"filename": "string",
"size": "string",
"mimeType": "string",
"extension": "string",
"publicUrl": "string",
"thumbUrl": "string",
"isThumbComplete": true,
"uploadLog": "string",
"createdAt": "2019-08-24T14:15:22Z",
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"filename": "string",
"size": "string",
"mimeType": "string",
"extension": "string",
"publicUrl": "string",
"thumbUrl": "string",
"isThumbComplete": true,
"uploadLog": "string",
"createdAt": "2019-08-24T14:15:22Z",
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of Content to update

Request Body schema: application/json

tenant	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
filename required	string
size required	string
mimeType required	string
extension required	string
publicUrl	string
thumbUrl	string
isThumbComplete	boolean
uploadLog	string^[0-9a-fA-F]{24}$ Refers to uploadLog
createdAt	string <date-time>
_id	string^[0-9a-fA-F]{24}$
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"tenant": "string",
"microsite": "string",
"filename": "string",
"size": "string",
"mimeType": "string",
"extension": "string",
"publicUrl": "string",
"thumbUrl": "string",
"isThumbComplete": true,
"uploadLog": "string",
"createdAt": "2019-08-24T14:15:22Z",
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"filename": "string",
"size": "string",
"mimeType": "string",
"extension": "string",
"publicUrl": "string",
"thumbUrl": "string",
"isThumbComplete": true,
"uploadLog": "string",
"createdAt": "2019-08-24T14:15:22Z",
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of Content to remove

Responses

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"filename": "string",
"size": "string",
"mimeType": "string",
"extension": "string",
"publicUrl": "string",
"thumbUrl": "string",
"isThumbComplete": true,
"uploadLog": "string",
"createdAt": "2019-08-24T14:15:22Z",
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

credit-card-transactions

A credit-card-transactions service

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (creditCardTransactions) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/credit-card-transactions?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"business": "string",
"microsite": "string",
"customer": "string",
"micrositeCustomer": "string",
"type": "CHARGE",
"amount": 0,
"transactionResult": true,
"transactionId": "string",
"transactionType": "string",
"message": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

business required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
micrositeCustomer	string^[0-9a-fA-F]{24}$ Refers to micrositeCustomers
type required	string Enum: "CHARGE" "REFUND"
amount required	number
transactionResult required	boolean
transactionId	string
transactionType	string
message required	string
createdAt	string <date-time>
updatedAt	string <date-time>
_id	string^[0-9a-fA-F]{24}$
__v	number

Responses

Request samples

Payload

Content type

application/json

{"business": "string",
"microsite": "string",
"customer": "string",
"micrositeCustomer": "string",
"type": "CHARGE",
"amount": 0,
"transactionResult": true,
"transactionId": "string",
"transactionType": "string",
"message": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"__v": 0
}

Response samples

201

Content type

application/json

{"business": "string",
"microsite": "string",
"customer": "string",
"micrositeCustomer": "string",
"type": "CHARGE",
"amount": 0,
"transactionResult": true,
"transactionId": "string",
"transactionType": "string",
"message": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of creditCardTransactions to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/credit-card-transactions/%7B_id%7D

Response samples

200

Content type

application/json

{"business": "string",
"microsite": "string",
"customer": "string",
"micrositeCustomer": "string",
"type": "CHARGE",
"amount": 0,
"transactionResult": true,
"transactionId": "string",
"transactionType": "string",
"message": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of creditCardTransactions to update

Request Body schema: application/json

business required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
micrositeCustomer	string^[0-9a-fA-F]{24}$ Refers to micrositeCustomers
type required	string Enum: "CHARGE" "REFUND"
amount required	number
transactionResult required	boolean
transactionId	string
transactionType	string
message required	string
createdAt	string <date-time>
updatedAt	string <date-time>
_id	string^[0-9a-fA-F]{24}$
__v	number

Responses

Request samples

Payload

Content type

application/json

{"business": "string",
"microsite": "string",
"customer": "string",
"micrositeCustomer": "string",
"type": "CHARGE",
"amount": 0,
"transactionResult": true,
"transactionId": "string",
"transactionType": "string",
"message": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"__v": 0
}

Response samples

200

Content type

application/json

{"business": "string",
"microsite": "string",
"customer": "string",
"micrositeCustomer": "string",
"type": "CHARGE",
"amount": 0,
"transactionResult": true,
"transactionId": "string",
"transactionType": "string",
"message": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of creditCardTransactions to update

Request Body schema: application/json

business required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
micrositeCustomer	string^[0-9a-fA-F]{24}$ Refers to micrositeCustomers
type required	string Enum: "CHARGE" "REFUND"
amount required	number
transactionResult required	boolean
transactionId	string
transactionType	string
message required	string
createdAt	string <date-time>
updatedAt	string <date-time>
_id	string^[0-9a-fA-F]{24}$
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"business": "string",
"microsite": "string",
"customer": "string",
"micrositeCustomer": "string",
"type": "CHARGE",
"amount": 0,
"transactionResult": true,
"transactionId": "string",
"transactionType": "string",
"message": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"__v": 0
}

Response samples

200

Content type

application/json

{"business": "string",
"microsite": "string",
"customer": "string",
"micrositeCustomer": "string",
"type": "CHARGE",
"amount": 0,
"transactionResult": true,
"transactionId": "string",
"transactionType": "string",
"message": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of creditCardTransactions to remove

Responses

Response samples

200

Content type

application/json

{"business": "string",
"microsite": "string",
"customer": "string",
"micrositeCustomer": "string",
"type": "CHARGE",
"amount": 0,
"transactionResult": true,
"transactionId": "string",
"transactionType": "string",
"message": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"_id": "string",
"__v": 0
}

credit-memo

A credit-memo service

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

id

required

integer

ID of not-documented to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/credit-memo/balance/%7Bid%7D

Response samples

200

Content type

application/json

{ }

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (creditMemo) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/credit-memo?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"business": "string",
"customer": "string",
"humanId": "string",
"invoice": "string",
"amount": 0,
"transactionType": "string",
"notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

business required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
humanId	string
invoice	string^[0-9a-fA-F]{24}$ Refers to invoices
amount required	number
transactionType	string
notes	string
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"business": "string",
"customer": "string",
"humanId": "string",
"invoice": "string",
"amount": 0,
"transactionType": "string",
"notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

{"business": "string",
"customer": "string",
"humanId": "string",
"invoice": "string",
"amount": 0,
"transactionType": "string",
"notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of creditMemo to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/credit-memo/%7B_id%7D

Response samples

200

Content type

application/json

{"business": "string",
"customer": "string",
"humanId": "string",
"invoice": "string",
"amount": 0,
"transactionType": "string",
"notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of creditMemo to update

Request Body schema: application/json

business required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
humanId	string
invoice	string^[0-9a-fA-F]{24}$ Refers to invoices
amount required	number
transactionType	string
notes	string
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"business": "string",
"customer": "string",
"humanId": "string",
"invoice": "string",
"amount": 0,
"transactionType": "string",
"notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"business": "string",
"customer": "string",
"humanId": "string",
"invoice": "string",
"amount": 0,
"transactionType": "string",
"notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of creditMemo to update

Request Body schema: application/json

business required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
humanId	string
invoice	string^[0-9a-fA-F]{24}$ Refers to invoices
amount required	number
transactionType	string
notes	string
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"business": "string",
"customer": "string",
"humanId": "string",
"invoice": "string",
"amount": 0,
"transactionType": "string",
"notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"business": "string",
"customer": "string",
"humanId": "string",
"invoice": "string",
"amount": 0,
"transactionType": "string",
"notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of creditMemo to remove

Responses

Response samples

200

Content type

application/json

{"business": "string",
"customer": "string",
"humanId": "string",
"invoice": "string",
"amount": 0,
"transactionType": "string",
"notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

custom

A custom service

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (customSandgCapitalOneCubes) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/custom/sandg/capital-one-cubes?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"tenant": "string",
"microsite": "string",
"name": "string",
"patentGrantDate": "string",
"patentTitle": "string",
"patentNumber": "string",
"productSku": "string",
"product": "string",
"email": "string",
"fulfillmentOrder": "string",
"fulfillmentOrderItem": "string",
"isClaimed": false,
"fulfillmentType": "cube",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite required	string^[0-9a-fA-F]{24}$ Refers to microsites
name	string
patentGrantDate required	string
patentTitle required	string
patentNumber required	string
productSku	string
product	string^[0-9a-fA-F]{24}$ Refers to ProductLegacy
email required	string
fulfillmentOrder	string^[0-9a-fA-F]{24}$ Refers to orders
fulfillmentOrderItem	string^[0-9a-fA-F]{24}$ Refers to orderItems
isClaimed	boolean Default: false
fulfillmentType	string Enum: "cube" "tree" "opt-out"
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"microsite": "string",
"name": "string",
"patentGrantDate": "string",
"patentTitle": "string",
"patentNumber": "string",
"productSku": "string",
"product": "string",
"email": "string",
"fulfillmentOrder": "string",
"fulfillmentOrderItem": "string",
"isClaimed": false,
"fulfillmentType": "cube",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

{"tenant": "string",
"microsite": "string",
"name": "string",
"patentGrantDate": "string",
"patentTitle": "string",
"patentNumber": "string",
"productSku": "string",
"product": "string",
"email": "string",
"fulfillmentOrder": "string",
"fulfillmentOrderItem": "string",
"isClaimed": false,
"fulfillmentType": "cube",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of customSandgCapitalOneCubes to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/custom/sandg/capital-one-cubes/%7B_id%7D

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"name": "string",
"patentGrantDate": "string",
"patentTitle": "string",
"patentNumber": "string",
"productSku": "string",
"product": "string",
"email": "string",
"fulfillmentOrder": "string",
"fulfillmentOrderItem": "string",
"isClaimed": false,
"fulfillmentType": "cube",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of customSandgCapitalOneCubes to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite required	string^[0-9a-fA-F]{24}$ Refers to microsites
name	string
patentGrantDate required	string
patentTitle required	string
patentNumber required	string
productSku	string
product	string^[0-9a-fA-F]{24}$ Refers to ProductLegacy
email required	string
fulfillmentOrder	string^[0-9a-fA-F]{24}$ Refers to orders
fulfillmentOrderItem	string^[0-9a-fA-F]{24}$ Refers to orderItems
isClaimed	boolean Default: false
fulfillmentType	string Enum: "cube" "tree" "opt-out"
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"microsite": "string",
"name": "string",
"patentGrantDate": "string",
"patentTitle": "string",
"patentNumber": "string",
"productSku": "string",
"product": "string",
"email": "string",
"fulfillmentOrder": "string",
"fulfillmentOrderItem": "string",
"isClaimed": false,
"fulfillmentType": "cube",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"name": "string",
"patentGrantDate": "string",
"patentTitle": "string",
"patentNumber": "string",
"productSku": "string",
"product": "string",
"email": "string",
"fulfillmentOrder": "string",
"fulfillmentOrderItem": "string",
"isClaimed": false,
"fulfillmentType": "cube",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of customSandgCapitalOneCubes to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
microsite required	string^[0-9a-fA-F]{24}$ Refers to microsites
name	string
patentGrantDate required	string
patentTitle required	string
patentNumber required	string
productSku	string
product	string^[0-9a-fA-F]{24}$ Refers to ProductLegacy
email required	string
fulfillmentOrder	string^[0-9a-fA-F]{24}$ Refers to orders
fulfillmentOrderItem	string^[0-9a-fA-F]{24}$ Refers to orderItems
isClaimed	boolean Default: false
fulfillmentType	string Enum: "cube" "tree" "opt-out"
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"tenant": "string",
"microsite": "string",
"name": "string",
"patentGrantDate": "string",
"patentTitle": "string",
"patentNumber": "string",
"productSku": "string",
"product": "string",
"email": "string",
"fulfillmentOrder": "string",
"fulfillmentOrderItem": "string",
"isClaimed": false,
"fulfillmentType": "cube",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"name": "string",
"patentGrantDate": "string",
"patentTitle": "string",
"patentNumber": "string",
"productSku": "string",
"product": "string",
"email": "string",
"fulfillmentOrder": "string",
"fulfillmentOrderItem": "string",
"isClaimed": false,
"fulfillmentType": "cube",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of customSandgCapitalOneCubes to remove

Responses

Response samples

200

Content type

application/json

{"tenant": "string",
"microsite": "string",
"name": "string",
"patentGrantDate": "string",
"patentTitle": "string",
"patentNumber": "string",
"productSku": "string",
"product": "string",
"email": "string",
"fulfillmentOrder": "string",
"fulfillmentOrderItem": "string",
"isClaimed": false,
"fulfillmentType": "cube",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

custom-quotes

A custom-quotes service

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (custom-quotes) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/custom-quotes?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"tenant": "string",
"customer": "string",
"salesPerson": "string",
"humanId": "string",
"items": [{"category": "string",
"categoryOther": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"others": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"price": 0,
"priceOverride": true,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"shipByType": "any",
"shipByDate": "2019-08-24T14:15:22Z",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnsOther": "string",
"addOnTotal": 0,
"staticName": "string",
"initialStatus": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"uploadedAttachments": ["string"
],
"miscUploads": ["string"
],
"type": "single-page",
"flatDimensions": {"width": 0,
"height": 0,
"length": 0,
"depth": 0,
"unitType": "inch",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"finishedDim": {"width": 0,
"height": 0,
"length": 0,
"depth": 0,
"unitType": "inch",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"additionalInfo": "string",
"messageThread": [{"createdAt": "2019-08-24T14:15:22Z",
"content": "string",
"attachments": ["string"
],
"author": {"type": "customer",
"user": "string",
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"noteToSelf": true,
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"cart": "string",
"excluded": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"subtotal": 0,
"shipping": 0,
"shippingOverriden": false,
"salesTax": 0,
"salesTaxOverriden": false,
"discount": 0,
"total": 0,
"shipTo": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"shipFrom": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"availableShippingMethods": [null
],
"availableShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"selectedShippingMethod": "string",
"selectedShippingService": "string",
"selectedShippingRate": "string",
"selectedPickupLocation": "string",
"po": "string",
"canCheckoutWithoutPayment": false,
"expirationDate": "2019-08-24T14:15:22Z",
"orderLogs": ["string"
],
"convertedToCart": false,
"convertedToOrders": [{"order": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"microsite": "string",
"micrositeUser": "string",
"uploadedAttachments": ["string"
],
"messageThread": [{"createdAt": "2019-08-24T14:15:22Z",
"content": "string",
"attachments": ["string"
],
"author": {"type": "customer",
"user": "string",
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"noteToSelf": true,
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"status": "open",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
salesPerson	string^[0-9a-fA-F]{24}$ Refers to salesPeople
humanId	string
	Array of objects (itemOf_items)
subtotal	number
shipping	number Default: 0
shippingOverriden	boolean Default: false
salesTax	number Default: 0
salesTaxOverriden	boolean Default: false
discount	number
total	number
	object (shipTo)
	object (shipFrom)
availableShippingMethods	Array of any
	Array of objects (itemOf_availableShippingRates)
selectedShippingMethod	string
selectedShippingService	string
selectedShippingRate	string
selectedPickupLocation	string^[0-9a-fA-F]{24}$ Refers to pickupLocations
po	string
canCheckoutWithoutPayment	boolean Default: false
expirationDate	string <date-time>
orderLogs	Array of strings
convertedToCart	boolean Default: false
	Array of objects (itemOf_convertedToOrders)
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
micrositeUser	string^[0-9a-fA-F]{24}$ Refers to micrositeCustomers
uploadedAttachments	Array of strings non-empty
	Array of objects (itemOf_messageThread)
status	string Default: "open" Enum: "open" "final" "closed"
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"customer": "string",
"salesPerson": "string",
"humanId": "string",
"items": [{"category": "string",
"categoryOther": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"others": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"price": 0,
"priceOverride": true,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"shipByType": "any",
"shipByDate": "2019-08-24T14:15:22Z",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnsOther": "string",
"addOnTotal": 0,
"staticName": "string",
"initialStatus": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"uploadedAttachments": ["string"
],
"miscUploads": ["string"
],
"type": "single-page",
"flatDimensions": {"width": 0,
"height": 0,
"length": 0,
"depth": 0,
"unitType": "inch",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"finishedDim": {"width": 0,
"height": 0,
"length": 0,
"depth": 0,
"unitType": "inch",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"additionalInfo": "string",
"messageThread": [{"createdAt": "2019-08-24T14:15:22Z",
"content": "string",
"attachments": ["string"
],
"author": {"type": "customer",
"user": "string",
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"noteToSelf": true,
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"cart": "string",
"excluded": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"subtotal": 0,
"shipping": 0,
"shippingOverriden": false,
"salesTax": 0,
"salesTaxOverriden": false,
"discount": 0,
"total": 0,
"shipTo": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"shipFrom": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"availableShippingMethods": [null
],
"availableShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"selectedShippingMethod": "string",
"selectedShippingService": "string",
"selectedShippingRate": "string",
"selectedPickupLocation": "string",
"po": "string",
"canCheckoutWithoutPayment": false,
"expirationDate": "2019-08-24T14:15:22Z",
"orderLogs": ["string"
],
"convertedToCart": false,
"convertedToOrders": [{"order": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"microsite": "string",
"micrositeUser": "string",
"uploadedAttachments": ["string"
],
"messageThread": [{"createdAt": "2019-08-24T14:15:22Z",
"content": "string",
"attachments": ["string"
],
"author": {"type": "customer",
"user": "string",
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"noteToSelf": true,
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"status": "open",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

{"tenant": "string",
"customer": "string",
"salesPerson": "string",
"humanId": "string",
"items": [{"category": "string",
"categoryOther": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"others": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"price": 0,
"priceOverride": true,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"shipByType": "any",
"shipByDate": "2019-08-24T14:15:22Z",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnsOther": "string",
"addOnTotal": 0,
"staticName": "string",
"initialStatus": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"uploadedAttachments": ["string"
],
"miscUploads": ["string"
],
"type": "single-page",
"flatDimensions": {"width": 0,
"height": 0,
"length": 0,
"depth": 0,
"unitType": "inch",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"finishedDim": {"width": 0,
"height": 0,
"length": 0,
"depth": 0,
"unitType": "inch",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"additionalInfo": "string",
"messageThread": [{"createdAt": "2019-08-24T14:15:22Z",
"content": "string",
"attachments": ["string"
],
"author": {"type": "customer",
"user": "string",
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"noteToSelf": true,
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"cart": "string",
"excluded": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"subtotal": 0,
"shipping": 0,
"shippingOverriden": false,
"salesTax": 0,
"salesTaxOverriden": false,
"discount": 0,
"total": 0,
"shipTo": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"shipFrom": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"availableShippingMethods": [null
],
"availableShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"selectedShippingMethod": "string",
"selectedShippingService": "string",
"selectedShippingRate": "string",
"selectedPickupLocation": "string",
"po": "string",
"canCheckoutWithoutPayment": false,
"expirationDate": "2019-08-24T14:15:22Z",
"orderLogs": ["string"
],
"convertedToCart": false,
"convertedToOrders": [{"order": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"microsite": "string",
"micrositeUser": "string",
"uploadedAttachments": ["string"
],
"messageThread": [{"createdAt": "2019-08-24T14:15:22Z",
"content": "string",
"attachments": ["string"
],
"author": {"type": "customer",
"user": "string",
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"noteToSelf": true,
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"status": "open",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of custom-quotes to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/custom-quotes/%7B_id%7D

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"salesPerson": "string",
"humanId": "string",
"items": [{"category": "string",
"categoryOther": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"others": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"price": 0,
"priceOverride": true,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"shipByType": "any",
"shipByDate": "2019-08-24T14:15:22Z",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnsOther": "string",
"addOnTotal": 0,
"staticName": "string",
"initialStatus": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"uploadedAttachments": ["string"
],
"miscUploads": ["string"
],
"type": "single-page",
"flatDimensions": {"width": 0,
"height": 0,
"length": 0,
"depth": 0,
"unitType": "inch",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"finishedDim": {"width": 0,
"height": 0,
"length": 0,
"depth": 0,
"unitType": "inch",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"additionalInfo": "string",
"messageThread": [{"createdAt": "2019-08-24T14:15:22Z",
"content": "string",
"attachments": ["string"
],
"author": {"type": "customer",
"user": "string",
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"noteToSelf": true,
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"cart": "string",
"excluded": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"subtotal": 0,
"shipping": 0,
"shippingOverriden": false,
"salesTax": 0,
"salesTaxOverriden": false,
"discount": 0,
"total": 0,
"shipTo": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"shipFrom": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"availableShippingMethods": [null
],
"availableShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"selectedShippingMethod": "string",
"selectedShippingService": "string",
"selectedShippingRate": "string",
"selectedPickupLocation": "string",
"po": "string",
"canCheckoutWithoutPayment": false,
"expirationDate": "2019-08-24T14:15:22Z",
"orderLogs": ["string"
],
"convertedToCart": false,
"convertedToOrders": [{"order": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"microsite": "string",
"micrositeUser": "string",
"uploadedAttachments": ["string"
],
"messageThread": [{"createdAt": "2019-08-24T14:15:22Z",
"content": "string",
"attachments": ["string"
],
"author": {"type": "customer",
"user": "string",
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"noteToSelf": true,
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"status": "open",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of custom-quotes to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
salesPerson	string^[0-9a-fA-F]{24}$ Refers to salesPeople
humanId	string
	Array of objects (itemOf_items)
subtotal	number
shipping	number Default: 0
shippingOverriden	boolean Default: false
salesTax	number Default: 0
salesTaxOverriden	boolean Default: false
discount	number
total	number
	object (shipTo)
	object (shipFrom)
availableShippingMethods	Array of any
	Array of objects (itemOf_availableShippingRates)
selectedShippingMethod	string
selectedShippingService	string
selectedShippingRate	string
selectedPickupLocation	string^[0-9a-fA-F]{24}$ Refers to pickupLocations
po	string
canCheckoutWithoutPayment	boolean Default: false
expirationDate	string <date-time>
orderLogs	Array of strings
convertedToCart	boolean Default: false
	Array of objects (itemOf_convertedToOrders)
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
micrositeUser	string^[0-9a-fA-F]{24}$ Refers to micrositeCustomers
uploadedAttachments	Array of strings non-empty
	Array of objects (itemOf_messageThread)
status	string Default: "open" Enum: "open" "final" "closed"
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"customer": "string",
"salesPerson": "string",
"humanId": "string",
"items": [{"category": "string",
"categoryOther": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"others": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"price": 0,
"priceOverride": true,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"shipByType": "any",
"shipByDate": "2019-08-24T14:15:22Z",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnsOther": "string",
"addOnTotal": 0,
"staticName": "string",
"initialStatus": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"uploadedAttachments": ["string"
],
"miscUploads": ["string"
],
"type": "single-page",
"flatDimensions": {"width": 0,
"height": 0,
"length": 0,
"depth": 0,
"unitType": "inch",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"finishedDim": {"width": 0,
"height": 0,
"length": 0,
"depth": 0,
"unitType": "inch",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"additionalInfo": "string",
"messageThread": [{"createdAt": "2019-08-24T14:15:22Z",
"content": "string",
"attachments": ["string"
],
"author": {"type": "customer",
"user": "string",
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"noteToSelf": true,
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"cart": "string",
"excluded": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"subtotal": 0,
"shipping": 0,
"shippingOverriden": false,
"salesTax": 0,
"salesTaxOverriden": false,
"discount": 0,
"total": 0,
"shipTo": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"shipFrom": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"availableShippingMethods": [null
],
"availableShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"selectedShippingMethod": "string",
"selectedShippingService": "string",
"selectedShippingRate": "string",
"selectedPickupLocation": "string",
"po": "string",
"canCheckoutWithoutPayment": false,
"expirationDate": "2019-08-24T14:15:22Z",
"orderLogs": ["string"
],
"convertedToCart": false,
"convertedToOrders": [{"order": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"microsite": "string",
"micrositeUser": "string",
"uploadedAttachments": ["string"
],
"messageThread": [{"createdAt": "2019-08-24T14:15:22Z",
"content": "string",
"attachments": ["string"
],
"author": {"type": "customer",
"user": "string",
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"noteToSelf": true,
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"status": "open",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"salesPerson": "string",
"humanId": "string",
"items": [{"category": "string",
"categoryOther": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"others": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"price": 0,
"priceOverride": true,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"shipByType": "any",
"shipByDate": "2019-08-24T14:15:22Z",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnsOther": "string",
"addOnTotal": 0,
"staticName": "string",
"initialStatus": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"uploadedAttachments": ["string"
],
"miscUploads": ["string"
],
"type": "single-page",
"flatDimensions": {"width": 0,
"height": 0,
"length": 0,
"depth": 0,
"unitType": "inch",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"finishedDim": {"width": 0,
"height": 0,
"length": 0,
"depth": 0,
"unitType": "inch",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"additionalInfo": "string",
"messageThread": [{"createdAt": "2019-08-24T14:15:22Z",
"content": "string",
"attachments": ["string"
],
"author": {"type": "customer",
"user": "string",
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"noteToSelf": true,
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"cart": "string",
"excluded": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"subtotal": 0,
"shipping": 0,
"shippingOverriden": false,
"salesTax": 0,
"salesTaxOverriden": false,
"discount": 0,
"total": 0,
"shipTo": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"shipFrom": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"availableShippingMethods": [null
],
"availableShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"selectedShippingMethod": "string",
"selectedShippingService": "string",
"selectedShippingRate": "string",
"selectedPickupLocation": "string",
"po": "string",
"canCheckoutWithoutPayment": false,
"expirationDate": "2019-08-24T14:15:22Z",
"orderLogs": ["string"
],
"convertedToCart": false,
"convertedToOrders": [{"order": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"microsite": "string",
"micrositeUser": "string",
"uploadedAttachments": ["string"
],
"messageThread": [{"createdAt": "2019-08-24T14:15:22Z",
"content": "string",
"attachments": ["string"
],
"author": {"type": "customer",
"user": "string",
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"noteToSelf": true,
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"status": "open",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of custom-quotes to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
salesPerson	string^[0-9a-fA-F]{24}$ Refers to salesPeople
humanId	string
	Array of objects (itemOf_items)
subtotal	number
shipping	number Default: 0
shippingOverriden	boolean Default: false
salesTax	number Default: 0
salesTaxOverriden	boolean Default: false
discount	number
total	number
	object (shipTo)
	object (shipFrom)
availableShippingMethods	Array of any
	Array of objects (itemOf_availableShippingRates)
selectedShippingMethod	string
selectedShippingService	string
selectedShippingRate	string
selectedPickupLocation	string^[0-9a-fA-F]{24}$ Refers to pickupLocations
po	string
canCheckoutWithoutPayment	boolean Default: false
expirationDate	string <date-time>
orderLogs	Array of strings
convertedToCart	boolean Default: false
	Array of objects (itemOf_convertedToOrders)
microsite	string^[0-9a-fA-F]{24}$ Refers to microsites
micrositeUser	string^[0-9a-fA-F]{24}$ Refers to micrositeCustomers
uploadedAttachments	Array of strings non-empty
	Array of objects (itemOf_messageThread)
status	string Default: "open" Enum: "open" "final" "closed"
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"tenant": "string",
"customer": "string",
"salesPerson": "string",
"humanId": "string",
"items": [{"category": "string",
"categoryOther": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"others": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"price": 0,
"priceOverride": true,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"shipByType": "any",
"shipByDate": "2019-08-24T14:15:22Z",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnsOther": "string",
"addOnTotal": 0,
"staticName": "string",
"initialStatus": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"uploadedAttachments": ["string"
],
"miscUploads": ["string"
],
"type": "single-page",
"flatDimensions": {"width": 0,
"height": 0,
"length": 0,
"depth": 0,
"unitType": "inch",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"finishedDim": {"width": 0,
"height": 0,
"length": 0,
"depth": 0,
"unitType": "inch",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"additionalInfo": "string",
"messageThread": [{"createdAt": "2019-08-24T14:15:22Z",
"content": "string",
"attachments": ["string"
],
"author": {"type": "customer",
"user": "string",
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"noteToSelf": true,
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"cart": "string",
"excluded": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"subtotal": 0,
"shipping": 0,
"shippingOverriden": false,
"salesTax": 0,
"salesTaxOverriden": false,
"discount": 0,
"total": 0,
"shipTo": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"shipFrom": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"availableShippingMethods": [null
],
"availableShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"selectedShippingMethod": "string",
"selectedShippingService": "string",
"selectedShippingRate": "string",
"selectedPickupLocation": "string",
"po": "string",
"canCheckoutWithoutPayment": false,
"expirationDate": "2019-08-24T14:15:22Z",
"orderLogs": ["string"
],
"convertedToCart": false,
"convertedToOrders": [{"order": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"microsite": "string",
"micrositeUser": "string",
"uploadedAttachments": ["string"
],
"messageThread": [{"createdAt": "2019-08-24T14:15:22Z",
"content": "string",
"attachments": ["string"
],
"author": {"type": "customer",
"user": "string",
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"noteToSelf": true,
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"status": "open",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"salesPerson": "string",
"humanId": "string",
"items": [{"category": "string",
"categoryOther": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"others": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"price": 0,
"priceOverride": true,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"shipByType": "any",
"shipByDate": "2019-08-24T14:15:22Z",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnsOther": "string",
"addOnTotal": 0,
"staticName": "string",
"initialStatus": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"uploadedAttachments": ["string"
],
"miscUploads": ["string"
],
"type": "single-page",
"flatDimensions": {"width": 0,
"height": 0,
"length": 0,
"depth": 0,
"unitType": "inch",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"finishedDim": {"width": 0,
"height": 0,
"length": 0,
"depth": 0,
"unitType": "inch",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"additionalInfo": "string",
"messageThread": [{"createdAt": "2019-08-24T14:15:22Z",
"content": "string",
"attachments": ["string"
],
"author": {"type": "customer",
"user": "string",
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"noteToSelf": true,
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"cart": "string",
"excluded": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"subtotal": 0,
"shipping": 0,
"shippingOverriden": false,
"salesTax": 0,
"salesTaxOverriden": false,
"discount": 0,
"total": 0,
"shipTo": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"shipFrom": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"availableShippingMethods": [null
],
"availableShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"selectedShippingMethod": "string",
"selectedShippingService": "string",
"selectedShippingRate": "string",
"selectedPickupLocation": "string",
"po": "string",
"canCheckoutWithoutPayment": false,
"expirationDate": "2019-08-24T14:15:22Z",
"orderLogs": ["string"
],
"convertedToCart": false,
"convertedToOrders": [{"order": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"microsite": "string",
"micrositeUser": "string",
"uploadedAttachments": ["string"
],
"messageThread": [{"createdAt": "2019-08-24T14:15:22Z",
"content": "string",
"attachments": ["string"
],
"author": {"type": "customer",
"user": "string",
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"noteToSelf": true,
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"status": "open",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of custom-quotes to remove

Responses

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"salesPerson": "string",
"humanId": "string",
"items": [{"category": "string",
"categoryOther": "string",
"attributes": [{"attributeId": "string",
"name": "string",
"key": "string",
"type": "string",
"others": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"customerReferenceName": "string",
"isCustomTrim": false,
"customTrimWidth": null,
"customTrimHeight": null,
"price": 0,
"priceOverride": true,
"designPrice": 0,
"quantity": 0,
"width": null,
"height": null,
"weight": null,
"length": 0,
"depth": 0,
"cartonType": "string",
"cartonTypeName": "string",
"timeMin": 0,
"timeMax": 0,
"orientation": "landscape",
"isShippable": true,
"wantDesign": false,
"turnaroundServiceType": null,
"turnaround": "string",
"shipByType": "any",
"shipByDate": "2019-08-24T14:15:22Z",
"pricingMethod": 0,
"addOns": [{"addOnId": "string",
"primaryData": "string",
"secondaryData": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"addOnsOther": "string",
"addOnTotal": 0,
"staticName": "string",
"initialStatus": "string",
"uploadSlots": [{"sequence": "string",
"url": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"metadata": [{"key": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"uploadedAttachments": ["string"
],
"miscUploads": ["string"
],
"type": "single-page",
"flatDimensions": {"width": 0,
"height": 0,
"length": 0,
"depth": 0,
"unitType": "inch",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"finishedDim": {"width": 0,
"height": 0,
"length": 0,
"depth": 0,
"unitType": "inch",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"additionalInfo": "string",
"messageThread": [{"createdAt": "2019-08-24T14:15:22Z",
"content": "string",
"attachments": ["string"
],
"author": {"type": "customer",
"user": "string",
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"noteToSelf": true,
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"cart": "string",
"excluded": true,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"subtotal": 0,
"shipping": 0,
"shippingOverriden": false,
"salesTax": 0,
"salesTaxOverriden": false,
"discount": 0,
"total": 0,
"shipTo": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"shipFrom": {"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"availableShippingMethods": [null
],
"availableShippingRates": [{"carrierKey": "string",
"carrier": "string",
"serviceKey": "string",
"description": "string",
"amount": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"selectedShippingMethod": "string",
"selectedShippingService": "string",
"selectedShippingRate": "string",
"selectedPickupLocation": "string",
"po": "string",
"canCheckoutWithoutPayment": false,
"expirationDate": "2019-08-24T14:15:22Z",
"orderLogs": ["string"
],
"convertedToCart": false,
"convertedToOrders": [{"order": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"microsite": "string",
"micrositeUser": "string",
"uploadedAttachments": ["string"
],
"messageThread": [{"createdAt": "2019-08-24T14:15:22Z",
"content": "string",
"attachments": ["string"
],
"author": {"type": "customer",
"user": "string",
"customer": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"noteToSelf": true,
"_id": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"status": "open",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

customer

A customer service

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (customerAuthLog) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/customer/auth-log?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"business": "string",
"email": "string",
"authResult": true,
"ip": "string",
"httpUserAgent": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

business required	string^[0-9a-fA-F]{24}$ Refers to tenants
email required	string
authResult required	boolean
ip	string
httpUserAgent	string
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"business": "string",
"email": "string",
"authResult": true,
"ip": "string",
"httpUserAgent": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

{"business": "string",
"email": "string",
"authResult": true,
"ip": "string",
"httpUserAgent": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of customerAuthLog to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/customer/auth-log/%7B_id%7D

Response samples

200

Content type

application/json

{"business": "string",
"email": "string",
"authResult": true,
"ip": "string",
"httpUserAgent": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of customerAuthLog to update

Request Body schema: application/json

business required	string^[0-9a-fA-F]{24}$ Refers to tenants
email required	string
authResult required	boolean
ip	string
httpUserAgent	string
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"business": "string",
"email": "string",
"authResult": true,
"ip": "string",
"httpUserAgent": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"business": "string",
"email": "string",
"authResult": true,
"ip": "string",
"httpUserAgent": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of customerAuthLog to update

Request Body schema: application/json

business required	string^[0-9a-fA-F]{24}$ Refers to tenants
email required	string
authResult required	boolean
ip	string
httpUserAgent	string
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"business": "string",
"email": "string",
"authResult": true,
"ip": "string",
"httpUserAgent": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"business": "string",
"email": "string",
"authResult": true,
"ip": "string",
"httpUserAgent": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of customerAuthLog to remove

Responses

Response samples

200

Content type

application/json

{"business": "string",
"email": "string",
"authResult": true,
"ip": "string",
"httpUserAgent": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

customer-artwork-library

A customer-artwork-library service

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (customerArtworkLibrary) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/customer-artwork-library?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"tenant": "string",
"customer": "string",
"collections": ["string"
],
"tags": ["string"
],
"artwork": "string",
"artworkFilename": "string",
"artworkThumbnails": [{"sequence": "string",
"url": "string",
"uploadLog": "string",
"contentImage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
collections	Array of strings non-empty
tags	Array of strings
artwork	string^[0-9a-fA-F]{24}$ Refers to uploadLog
artworkFilename	string
	Array of objects (itemOf_artworkThumbnails)
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"customer": "string",
"collections": ["string"
],
"tags": ["string"
],
"artwork": "string",
"artworkFilename": "string",
"artworkThumbnails": [{"sequence": "string",
"url": "string",
"uploadLog": "string",
"contentImage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

{"tenant": "string",
"customer": "string",
"collections": ["string"
],
"tags": ["string"
],
"artwork": "string",
"artworkFilename": "string",
"artworkThumbnails": [{"sequence": "string",
"url": "string",
"uploadLog": "string",
"contentImage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of customerArtworkLibrary to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/customer-artwork-library/%7B_id%7D

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"collections": ["string"
],
"tags": ["string"
],
"artwork": "string",
"artworkFilename": "string",
"artworkThumbnails": [{"sequence": "string",
"url": "string",
"uploadLog": "string",
"contentImage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of customerArtworkLibrary to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
collections	Array of strings non-empty
tags	Array of strings
artwork	string^[0-9a-fA-F]{24}$ Refers to uploadLog
artworkFilename	string
	Array of objects (itemOf_artworkThumbnails)
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"customer": "string",
"collections": ["string"
],
"tags": ["string"
],
"artwork": "string",
"artworkFilename": "string",
"artworkThumbnails": [{"sequence": "string",
"url": "string",
"uploadLog": "string",
"contentImage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"collections": ["string"
],
"tags": ["string"
],
"artwork": "string",
"artworkFilename": "string",
"artworkThumbnails": [{"sequence": "string",
"url": "string",
"uploadLog": "string",
"contentImage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of customerArtworkLibrary to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
collections	Array of strings non-empty
tags	Array of strings
artwork	string^[0-9a-fA-F]{24}$ Refers to uploadLog
artworkFilename	string
	Array of objects (itemOf_artworkThumbnails)
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"tenant": "string",
"customer": "string",
"collections": ["string"
],
"tags": ["string"
],
"artwork": "string",
"artworkFilename": "string",
"artworkThumbnails": [{"sequence": "string",
"url": "string",
"uploadLog": "string",
"contentImage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"collections": ["string"
],
"tags": ["string"
],
"artwork": "string",
"artworkFilename": "string",
"artworkThumbnails": [{"sequence": "string",
"url": "string",
"uploadLog": "string",
"contentImage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of customerArtworkLibrary to remove

Responses

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"collections": ["string"
],
"tags": ["string"
],
"artwork": "string",
"artworkFilename": "string",
"artworkThumbnails": [{"sequence": "string",
"url": "string",
"uploadLog": "string",
"contentImage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

customer-artwork-library-collections

A customer-artwork-library-collections service

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (customerArtworkLibraryCollections) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/customer-artwork-library-collections?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"tenant": "string",
"customer": "string",
"name": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
name	string
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"customer": "string",
"name": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

{"tenant": "string",
"customer": "string",
"name": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of customerArtworkLibraryCollections to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/customer-artwork-library-collections/%7B_id%7D

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"name": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of customerArtworkLibraryCollections to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
name	string
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"customer": "string",
"name": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"name": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of customerArtworkLibraryCollections to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
name	string
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"tenant": "string",
"customer": "string",
"name": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"name": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of customerArtworkLibraryCollections to remove

Responses

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"name": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

customer-link-token

A customer-link-token service

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

customer-order-stats

A customer-order-stats service

Creates a new resource with data.

Request Body schema: application/json

object (fulfillment-staging-locations/staged)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

customer-product-library

A customer-product-library service

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (customerProductLibrary) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/customer-product-library?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"tenant": "string",
"customer": "string",
"product": "string",
"category": "string",
"customerArtwork": "string",
"artwork": "string",
"artworkFilename": "string",
"artworkThumbnails": [{"sequence": "string",
"url": "string",
"contentImage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"thumbnail": {"uploadLog": "string",
"url": "string"
},
"name": "string",
"customerSku": "string",
"productAttributes": [{"attribute": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"collections": ["string"
],
"tags": ["string"
],
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
product required	string^[0-9a-fA-F]{24}$ Refers to ProductLegacy
category required	string^[0-9a-fA-F]{24}$ Refers to productCategoryLegacy
customerArtwork	string^[0-9a-fA-F]{24}$ Refers to customerArtworkLibrary
artwork	string^[0-9a-fA-F]{24}$ Refers to uploadLog
artworkFilename	string
	Array of objects (itemOf_artworkThumbnails)
	object (thumbnail)
name	string
customerSku	string
	Array of objects (itemOf_productAttributes)
collections	Array of strings non-empty
tags	Array of strings
	Array of objects (itemOf_designTemplateFields)
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"customer": "string",
"product": "string",
"category": "string",
"customerArtwork": "string",
"artwork": "string",
"artworkFilename": "string",
"artworkThumbnails": [{"sequence": "string",
"url": "string",
"contentImage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"thumbnail": {"uploadLog": "string",
"url": "string"
},
"name": "string",
"customerSku": "string",
"productAttributes": [{"attribute": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"collections": ["string"
],
"tags": ["string"
],
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

{"tenant": "string",
"customer": "string",
"product": "string",
"category": "string",
"customerArtwork": "string",
"artwork": "string",
"artworkFilename": "string",
"artworkThumbnails": [{"sequence": "string",
"url": "string",
"contentImage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"thumbnail": {"uploadLog": "string",
"url": "string"
},
"name": "string",
"customerSku": "string",
"productAttributes": [{"attribute": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"collections": ["string"
],
"tags": ["string"
],
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of customerProductLibrary to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/customer-product-library/%7B_id%7D

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"product": "string",
"category": "string",
"customerArtwork": "string",
"artwork": "string",
"artworkFilename": "string",
"artworkThumbnails": [{"sequence": "string",
"url": "string",
"contentImage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"thumbnail": {"uploadLog": "string",
"url": "string"
},
"name": "string",
"customerSku": "string",
"productAttributes": [{"attribute": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"collections": ["string"
],
"tags": ["string"
],
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of customerProductLibrary to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
product required	string^[0-9a-fA-F]{24}$ Refers to ProductLegacy
category required	string^[0-9a-fA-F]{24}$ Refers to productCategoryLegacy
customerArtwork	string^[0-9a-fA-F]{24}$ Refers to customerArtworkLibrary
artwork	string^[0-9a-fA-F]{24}$ Refers to uploadLog
artworkFilename	string
	Array of objects (itemOf_artworkThumbnails)
	object (thumbnail)
name	string
customerSku	string
	Array of objects (itemOf_productAttributes)
collections	Array of strings non-empty
tags	Array of strings
	Array of objects (itemOf_designTemplateFields)
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"customer": "string",
"product": "string",
"category": "string",
"customerArtwork": "string",
"artwork": "string",
"artworkFilename": "string",
"artworkThumbnails": [{"sequence": "string",
"url": "string",
"contentImage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"thumbnail": {"uploadLog": "string",
"url": "string"
},
"name": "string",
"customerSku": "string",
"productAttributes": [{"attribute": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"collections": ["string"
],
"tags": ["string"
],
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"product": "string",
"category": "string",
"customerArtwork": "string",
"artwork": "string",
"artworkFilename": "string",
"artworkThumbnails": [{"sequence": "string",
"url": "string",
"contentImage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"thumbnail": {"uploadLog": "string",
"url": "string"
},
"name": "string",
"customerSku": "string",
"productAttributes": [{"attribute": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"collections": ["string"
],
"tags": ["string"
],
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of customerProductLibrary to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
product required	string^[0-9a-fA-F]{24}$ Refers to ProductLegacy
category required	string^[0-9a-fA-F]{24}$ Refers to productCategoryLegacy
customerArtwork	string^[0-9a-fA-F]{24}$ Refers to customerArtworkLibrary
artwork	string^[0-9a-fA-F]{24}$ Refers to uploadLog
artworkFilename	string
	Array of objects (itemOf_artworkThumbnails)
	object (thumbnail)
name	string
customerSku	string
	Array of objects (itemOf_productAttributes)
collections	Array of strings non-empty
tags	Array of strings
	Array of objects (itemOf_designTemplateFields)
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"tenant": "string",
"customer": "string",
"product": "string",
"category": "string",
"customerArtwork": "string",
"artwork": "string",
"artworkFilename": "string",
"artworkThumbnails": [{"sequence": "string",
"url": "string",
"contentImage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"thumbnail": {"uploadLog": "string",
"url": "string"
},
"name": "string",
"customerSku": "string",
"productAttributes": [{"attribute": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"collections": ["string"
],
"tags": ["string"
],
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"product": "string",
"category": "string",
"customerArtwork": "string",
"artwork": "string",
"artworkFilename": "string",
"artworkThumbnails": [{"sequence": "string",
"url": "string",
"contentImage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"thumbnail": {"uploadLog": "string",
"url": "string"
},
"name": "string",
"customerSku": "string",
"productAttributes": [{"attribute": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"collections": ["string"
],
"tags": ["string"
],
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of customerProductLibrary to remove

Responses

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"product": "string",
"category": "string",
"customerArtwork": "string",
"artwork": "string",
"artworkFilename": "string",
"artworkThumbnails": [{"sequence": "string",
"url": "string",
"contentImage": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"thumbnail": {"uploadLog": "string",
"url": "string"
},
"name": "string",
"customerSku": "string",
"productAttributes": [{"attribute": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"collections": ["string"
],
"tags": ["string"
],
"designTemplateFields": [{"key": "string",
"label": "string",
"value": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

customer-product-library-collections

A customer-product-library-collections service

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (customerProductLibraryCollections) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/customer-product-library-collections?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"tenant": "string",
"customer": "string",
"name": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
name	string
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"customer": "string",
"name": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

{"tenant": "string",
"customer": "string",
"name": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of customerProductLibraryCollections to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/customer-product-library-collections/%7B_id%7D

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"name": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of customerProductLibraryCollections to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
name	string
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"customer": "string",
"name": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"name": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of customerProductLibraryCollections to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
name	string
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"tenant": "string",
"customer": "string",
"name": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"name": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Removes the resource with id.

path Parameters

_id

required

integer

ID of customerProductLibraryCollections to remove

Responses

Response samples

200

Content type

application/json

{"tenant": "string",
"customer": "string",
"name": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

customer-quote-requests

A customer-quote-requests service

Retrieves a list of all resources from the service

Retrieves a list of all resources from the service.

query Parameters

$limit	integer Number of results to return
$skip	integer Number of results to skip
$sort	object Property to sort results
	object (customerQuoteRequests) Query parameters to filter

Responses

Request samples

Shell + Curl

curl --request GET \
  --url 'https://api.inkcloud9.com/customer-quote-requests?%24limit=SOME_INTEGER_VALUE&%24skip=SOME_INTEGER_VALUE&%24sort=SOME_OBJECT_VALUE&filter=SOME_OBJECT_VALUE'

Response samples

200

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"tenant": "string",
"humanId": 0,
"customer": "string",
"deleted": false,
"deletedAt": "2019-08-24T14:15:22Z",
"deletedBy": "string",
"deletedByModel": "user",
"title": "string",
"status": {"current": "Draft",
"history": [{"status": "string",
"changed_at": "2019-08-24T14:15:22Z",
"changed_by": "string",
"notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"urgency": "Standard",
"budget": {"min": 0,
"max": 0,
"currency": "USD",
"flexibility": "Strict"
},
"timeline": {"requestedQuoteByDate": "2019-08-24T14:15:22Z",
"requestedDelivery_date": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z"
},
"items": [{"name": "string",
"quantity": 0,
"category": {"category_id": "string",
"name": "string"
},
"description": "string",
"specifications": [{"spec_id": "string",
"name": "string",
"specType": "dimension",
"structured": {"value": null,
"unit": "string",
"option_id": "string"
},
"unstructured": "string",
"isRequired": false,
"displayOrder": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"itemAttachments": [{"attachedAt": "2019-08-24T14:15:22Z",
"filename": "string",
"size": "string",
"label": "string",
"uploadLog": "string",
"attachedBy": "string",
"attachedByModel": "user",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"shipping": {"addresses": [{"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"method": "string",
"instructions": "string"
},
"attachments": [{"attachedAt": "2019-08-24T14:15:22Z",
"filename": "string",
"size": "string",
"label": "string",
"uploadLog": "string",
"attachedBy": "string",
"attachedByModel": "user",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"notes": {"customerNotes": "string",
"internalNotes": "string",
"communicationHistory": [{"date": "2019-08-24T14:15:22Z",
"author_id": "string",
"author_type": "customer",
"message": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"quotation": {"quote_id": "string",
"quote_date": "2019-08-24T14:15:22Z",
"valid_until": "2019-08-24T14:15:22Z",
"subtotal": 0,
"tax": 0,
"shipping": 0,
"total": 0,
"estimated_delivery": "2019-08-24T14:15:22Z",
"items": [{"item_id": "string",
"name": "string",
"quantity": 0,
"unitPrice": 0,
"total": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"additional_notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"relatedEntities": {"orderId": "string",
"supplierPricingRequestIds": ["string"
],
"internalCostCalculationId": "string",
"previousQuoteRequestId": "string"
},
"customFields": null,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]
}

Creates a new resource with data.

Request Body schema: application/json

One of

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
humanId	number
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
deleted	boolean Default: false
deletedAt	string <date-time>
deletedBy	string^[0-9a-fA-F]{24}$
deletedByModel	string Enum: "user" "commandCenterUser" "micrositeCustomers"
title required	string
	object (status)
urgency	string Default: "Standard" Enum: "Standard" "Rush" "Critical"
	object (budget)
	object (timeline)
	Array of objects (itemOf_items)
	object (shipping)
	Array of objects (itemOf_attachments)
	object (notes)
	object (quotation)
	object (relatedEntities)
customFields	any
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

Example

customerQuoteRequests

{"tenant": "string",
"humanId": 0,
"customer": "string",
"deleted": false,
"deletedAt": "2019-08-24T14:15:22Z",
"deletedBy": "string",
"deletedByModel": "user",
"title": "string",
"status": {"current": "Draft",
"history": [{"status": "string",
"changed_at": "2019-08-24T14:15:22Z",
"changed_by": "string",
"notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"urgency": "Standard",
"budget": {"min": 0,
"max": 0,
"currency": "USD",
"flexibility": "Strict"
},
"timeline": {"requestedQuoteByDate": "2019-08-24T14:15:22Z",
"requestedDelivery_date": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z"
},
"items": [{"name": "string",
"quantity": 0,
"category": {"category_id": "string",
"name": "string"
},
"description": "string",
"specifications": [{"spec_id": "string",
"name": "string",
"specType": "dimension",
"structured": {"value": null,
"unit": "string",
"option_id": "string"
},
"unstructured": "string",
"isRequired": false,
"displayOrder": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"itemAttachments": [{"attachedAt": "2019-08-24T14:15:22Z",
"filename": "string",
"size": "string",
"label": "string",
"uploadLog": "string",
"attachedBy": "string",
"attachedByModel": "user",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"shipping": {"addresses": [{"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"method": "string",
"instructions": "string"
},
"attachments": [{"attachedAt": "2019-08-24T14:15:22Z",
"filename": "string",
"size": "string",
"label": "string",
"uploadLog": "string",
"attachedBy": "string",
"attachedByModel": "user",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"notes": {"customerNotes": "string",
"internalNotes": "string",
"communicationHistory": [{"date": "2019-08-24T14:15:22Z",
"author_id": "string",
"author_type": "customer",
"message": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"quotation": {"quote_id": "string",
"quote_date": "2019-08-24T14:15:22Z",
"valid_until": "2019-08-24T14:15:22Z",
"subtotal": 0,
"tax": 0,
"shipping": 0,
"total": 0,
"estimated_delivery": "2019-08-24T14:15:22Z",
"items": [{"item_id": "string",
"name": "string",
"quantity": 0,
"unitPrice": 0,
"total": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"additional_notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"relatedEntities": {"orderId": "string",
"supplierPricingRequestIds": ["string"
],
"internalCostCalculationId": "string",
"previousQuoteRequestId": "string"
},
"customFields": null,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

201

Content type

application/json

Example

customerQuoteRequests

{"tenant": "string",
"humanId": 0,
"customer": "string",
"deleted": false,
"deletedAt": "2019-08-24T14:15:22Z",
"deletedBy": "string",
"deletedByModel": "user",
"title": "string",
"status": {"current": "Draft",
"history": [{"status": "string",
"changed_at": "2019-08-24T14:15:22Z",
"changed_by": "string",
"notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"urgency": "Standard",
"budget": {"min": 0,
"max": 0,
"currency": "USD",
"flexibility": "Strict"
},
"timeline": {"requestedQuoteByDate": "2019-08-24T14:15:22Z",
"requestedDelivery_date": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z"
},
"items": [{"name": "string",
"quantity": 0,
"category": {"category_id": "string",
"name": "string"
},
"description": "string",
"specifications": [{"spec_id": "string",
"name": "string",
"specType": "dimension",
"structured": {"value": null,
"unit": "string",
"option_id": "string"
},
"unstructured": "string",
"isRequired": false,
"displayOrder": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"itemAttachments": [{"attachedAt": "2019-08-24T14:15:22Z",
"filename": "string",
"size": "string",
"label": "string",
"uploadLog": "string",
"attachedBy": "string",
"attachedByModel": "user",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"shipping": {"addresses": [{"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"method": "string",
"instructions": "string"
},
"attachments": [{"attachedAt": "2019-08-24T14:15:22Z",
"filename": "string",
"size": "string",
"label": "string",
"uploadLog": "string",
"attachedBy": "string",
"attachedByModel": "user",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"notes": {"customerNotes": "string",
"internalNotes": "string",
"communicationHistory": [{"date": "2019-08-24T14:15:22Z",
"author_id": "string",
"author_type": "customer",
"message": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"quotation": {"quote_id": "string",
"quote_date": "2019-08-24T14:15:22Z",
"valid_until": "2019-08-24T14:15:22Z",
"subtotal": 0,
"tax": 0,
"shipping": 0,
"total": 0,
"estimated_delivery": "2019-08-24T14:15:22Z",
"items": [{"item_id": "string",
"name": "string",
"quantity": 0,
"unitPrice": 0,
"total": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"additional_notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"relatedEntities": {"orderId": "string",
"supplierPricingRequestIds": ["string"
],
"internalCostCalculationId": "string",
"previousQuoteRequestId": "string"
},
"customFields": null,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates multiple resources.

Request Body schema: application/json

Array

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
humanId	number
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
deleted	boolean Default: false
deletedAt	string <date-time>
deletedBy	string^[0-9a-fA-F]{24}$
deletedByModel	string Enum: "user" "commandCenterUser" "micrositeCustomers"
title required	string
	object (status)
urgency	string Default: "Standard" Enum: "Standard" "Rush" "Critical"
	object (budget)
	object (timeline)
	Array of objects (itemOf_items)
	object (shipping)
	Array of objects (itemOf_attachments)
	object (notes)
	object (quotation)
	object (relatedEntities)
customFields	any
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

[{"tenant": "string",
"humanId": 0,
"customer": "string",
"deleted": false,
"deletedAt": "2019-08-24T14:15:22Z",
"deletedBy": "string",
"deletedByModel": "user",
"title": "string",
"status": {"current": "Draft",
"history": [{"status": "string",
"changed_at": "2019-08-24T14:15:22Z",
"changed_by": "string",
"notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"urgency": "Standard",
"budget": {"min": 0,
"max": 0,
"currency": "USD",
"flexibility": "Strict"
},
"timeline": {"requestedQuoteByDate": "2019-08-24T14:15:22Z",
"requestedDelivery_date": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z"
},
"items": [{"name": "string",
"quantity": 0,
"category": {"category_id": "string",
"name": "string"
},
"description": "string",
"specifications": [{"spec_id": "string",
"name": "string",
"specType": "dimension",
"structured": {"value": null,
"unit": "string",
"option_id": "string"
},
"unstructured": "string",
"isRequired": false,
"displayOrder": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"itemAttachments": [{"attachedAt": "2019-08-24T14:15:22Z",
"filename": "string",
"size": "string",
"label": "string",
"uploadLog": "string",
"attachedBy": "string",
"attachedByModel": "user",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"shipping": {"addresses": [{"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"method": "string",
"instructions": "string"
},
"attachments": [{"attachedAt": "2019-08-24T14:15:22Z",
"filename": "string",
"size": "string",
"label": "string",
"uploadLog": "string",
"attachedBy": "string",
"attachedByModel": "user",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"notes": {"customerNotes": "string",
"internalNotes": "string",
"communicationHistory": [{"date": "2019-08-24T14:15:22Z",
"author_id": "string",
"author_type": "customer",
"message": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"quotation": {"quote_id": "string",
"quote_date": "2019-08-24T14:15:22Z",
"valid_until": "2019-08-24T14:15:22Z",
"subtotal": 0,
"tax": 0,
"shipping": 0,
"total": 0,
"estimated_delivery": "2019-08-24T14:15:22Z",
"items": [{"item_id": "string",
"name": "string",
"quantity": 0,
"unitPrice": 0,
"total": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"additional_notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"relatedEntities": {"orderId": "string",
"supplierPricingRequestIds": ["string"
],
"internalCostCalculationId": "string",
"previousQuoteRequestId": "string"
},
"customFields": null,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]

Response samples

200

Content type

application/json

[{"tenant": "string",
"humanId": 0,
"customer": "string",
"deleted": false,
"deletedAt": "2019-08-24T14:15:22Z",
"deletedBy": "string",
"deletedByModel": "user",
"title": "string",
"status": {"current": "Draft",
"history": [{"status": "string",
"changed_at": "2019-08-24T14:15:22Z",
"changed_by": "string",
"notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"urgency": "Standard",
"budget": {"min": 0,
"max": 0,
"currency": "USD",
"flexibility": "Strict"
},
"timeline": {"requestedQuoteByDate": "2019-08-24T14:15:22Z",
"requestedDelivery_date": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z"
},
"items": [{"name": "string",
"quantity": 0,
"category": {"category_id": "string",
"name": "string"
},
"description": "string",
"specifications": [{"spec_id": "string",
"name": "string",
"specType": "dimension",
"structured": {"value": null,
"unit": "string",
"option_id": "string"
},
"unstructured": "string",
"isRequired": false,
"displayOrder": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"itemAttachments": [{"attachedAt": "2019-08-24T14:15:22Z",
"filename": "string",
"size": "string",
"label": "string",
"uploadLog": "string",
"attachedBy": "string",
"attachedByModel": "user",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"shipping": {"addresses": [{"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"method": "string",
"instructions": "string"
},
"attachments": [{"attachedAt": "2019-08-24T14:15:22Z",
"filename": "string",
"size": "string",
"label": "string",
"uploadLog": "string",
"attachedBy": "string",
"attachedByModel": "user",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"notes": {"customerNotes": "string",
"internalNotes": "string",
"communicationHistory": [{"date": "2019-08-24T14:15:22Z",
"author_id": "string",
"author_type": "customer",
"message": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"quotation": {"quote_id": "string",
"quote_date": "2019-08-24T14:15:22Z",
"valid_until": "2019-08-24T14:15:22Z",
"subtotal": 0,
"tax": 0,
"shipping": 0,
"total": 0,
"estimated_delivery": "2019-08-24T14:15:22Z",
"items": [{"item_id": "string",
"name": "string",
"quantity": 0,
"unitPrice": 0,
"total": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"additional_notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"relatedEntities": {"orderId": "string",
"supplierPricingRequestIds": ["string"
],
"internalCostCalculationId": "string",
"previousQuoteRequestId": "string"
},
"customFields": null,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]

Updates multiple resources queried by given filter

Updates multiple resources queried by given filters.

query Parameters

object (customerQuoteRequests)

Query parameters to filter

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
humanId	number
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
deleted	boolean Default: false
deletedAt	string <date-time>
deletedBy	string^[0-9a-fA-F]{24}$
deletedByModel	string Enum: "user" "commandCenterUser" "micrositeCustomers"
title required	string
	object (status)
urgency	string Default: "Standard" Enum: "Standard" "Rush" "Critical"
	object (budget)
	object (timeline)
	Array of objects (itemOf_items)
	object (shipping)
	Array of objects (itemOf_attachments)
	object (notes)
	object (quotation)
	object (relatedEntities)
customFields	any
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"tenant": "string",
"humanId": 0,
"customer": "string",
"deleted": false,
"deletedAt": "2019-08-24T14:15:22Z",
"deletedBy": "string",
"deletedByModel": "user",
"title": "string",
"status": {"current": "Draft",
"history": [{"status": "string",
"changed_at": "2019-08-24T14:15:22Z",
"changed_by": "string",
"notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"urgency": "Standard",
"budget": {"min": 0,
"max": 0,
"currency": "USD",
"flexibility": "Strict"
},
"timeline": {"requestedQuoteByDate": "2019-08-24T14:15:22Z",
"requestedDelivery_date": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z"
},
"items": [{"name": "string",
"quantity": 0,
"category": {"category_id": "string",
"name": "string"
},
"description": "string",
"specifications": [{"spec_id": "string",
"name": "string",
"specType": "dimension",
"structured": {"value": null,
"unit": "string",
"option_id": "string"
},
"unstructured": "string",
"isRequired": false,
"displayOrder": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"itemAttachments": [{"attachedAt": "2019-08-24T14:15:22Z",
"filename": "string",
"size": "string",
"label": "string",
"uploadLog": "string",
"attachedBy": "string",
"attachedByModel": "user",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"shipping": {"addresses": [{"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"method": "string",
"instructions": "string"
},
"attachments": [{"attachedAt": "2019-08-24T14:15:22Z",
"filename": "string",
"size": "string",
"label": "string",
"uploadLog": "string",
"attachedBy": "string",
"attachedByModel": "user",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"notes": {"customerNotes": "string",
"internalNotes": "string",
"communicationHistory": [{"date": "2019-08-24T14:15:22Z",
"author_id": "string",
"author_type": "customer",
"message": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"quotation": {"quote_id": "string",
"quote_date": "2019-08-24T14:15:22Z",
"valid_until": "2019-08-24T14:15:22Z",
"subtotal": 0,
"tax": 0,
"shipping": 0,
"total": 0,
"estimated_delivery": "2019-08-24T14:15:22Z",
"items": [{"item_id": "string",
"name": "string",
"quantity": 0,
"unitPrice": 0,
"total": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"additional_notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"relatedEntities": {"orderId": "string",
"supplierPricingRequestIds": ["string"
],
"internalCostCalculationId": "string",
"previousQuoteRequestId": "string"
},
"customFields": null,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

[{"tenant": "string",
"humanId": 0,
"customer": "string",
"deleted": false,
"deletedAt": "2019-08-24T14:15:22Z",
"deletedBy": "string",
"deletedByModel": "user",
"title": "string",
"status": {"current": "Draft",
"history": [{"status": "string",
"changed_at": "2019-08-24T14:15:22Z",
"changed_by": "string",
"notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"urgency": "Standard",
"budget": {"min": 0,
"max": 0,
"currency": "USD",
"flexibility": "Strict"
},
"timeline": {"requestedQuoteByDate": "2019-08-24T14:15:22Z",
"requestedDelivery_date": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z"
},
"items": [{"name": "string",
"quantity": 0,
"category": {"category_id": "string",
"name": "string"
},
"description": "string",
"specifications": [{"spec_id": "string",
"name": "string",
"specType": "dimension",
"structured": {"value": null,
"unit": "string",
"option_id": "string"
},
"unstructured": "string",
"isRequired": false,
"displayOrder": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"itemAttachments": [{"attachedAt": "2019-08-24T14:15:22Z",
"filename": "string",
"size": "string",
"label": "string",
"uploadLog": "string",
"attachedBy": "string",
"attachedByModel": "user",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"shipping": {"addresses": [{"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"method": "string",
"instructions": "string"
},
"attachments": [{"attachedAt": "2019-08-24T14:15:22Z",
"filename": "string",
"size": "string",
"label": "string",
"uploadLog": "string",
"attachedBy": "string",
"attachedByModel": "user",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"notes": {"customerNotes": "string",
"internalNotes": "string",
"communicationHistory": [{"date": "2019-08-24T14:15:22Z",
"author_id": "string",
"author_type": "customer",
"message": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"quotation": {"quote_id": "string",
"quote_date": "2019-08-24T14:15:22Z",
"valid_until": "2019-08-24T14:15:22Z",
"subtotal": 0,
"tax": 0,
"shipping": 0,
"total": 0,
"estimated_delivery": "2019-08-24T14:15:22Z",
"items": [{"item_id": "string",
"name": "string",
"quantity": 0,
"unitPrice": 0,
"total": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"additional_notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"relatedEntities": {"orderId": "string",
"supplierPricingRequestIds": ["string"
],
"internalCostCalculationId": "string",
"previousQuoteRequestId": "string"
},
"customFields": null,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]

Removes multiple resources queried by given filter

Removes multiple resources queried by given filters.

query Parameters

object (customerQuoteRequests)

Query parameters to filter

Responses

Response samples

200

Content type

application/json

[{"tenant": "string",
"humanId": 0,
"customer": "string",
"deleted": false,
"deletedAt": "2019-08-24T14:15:22Z",
"deletedBy": "string",
"deletedByModel": "user",
"title": "string",
"status": {"current": "Draft",
"history": [{"status": "string",
"changed_at": "2019-08-24T14:15:22Z",
"changed_by": "string",
"notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"urgency": "Standard",
"budget": {"min": 0,
"max": 0,
"currency": "USD",
"flexibility": "Strict"
},
"timeline": {"requestedQuoteByDate": "2019-08-24T14:15:22Z",
"requestedDelivery_date": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z"
},
"items": [{"name": "string",
"quantity": 0,
"category": {"category_id": "string",
"name": "string"
},
"description": "string",
"specifications": [{"spec_id": "string",
"name": "string",
"specType": "dimension",
"structured": {"value": null,
"unit": "string",
"option_id": "string"
},
"unstructured": "string",
"isRequired": false,
"displayOrder": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"itemAttachments": [{"attachedAt": "2019-08-24T14:15:22Z",
"filename": "string",
"size": "string",
"label": "string",
"uploadLog": "string",
"attachedBy": "string",
"attachedByModel": "user",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"shipping": {"addresses": [{"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"method": "string",
"instructions": "string"
},
"attachments": [{"attachedAt": "2019-08-24T14:15:22Z",
"filename": "string",
"size": "string",
"label": "string",
"uploadLog": "string",
"attachedBy": "string",
"attachedByModel": "user",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"notes": {"customerNotes": "string",
"internalNotes": "string",
"communicationHistory": [{"date": "2019-08-24T14:15:22Z",
"author_id": "string",
"author_type": "customer",
"message": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"quotation": {"quote_id": "string",
"quote_date": "2019-08-24T14:15:22Z",
"valid_until": "2019-08-24T14:15:22Z",
"subtotal": 0,
"tax": 0,
"shipping": 0,
"total": 0,
"estimated_delivery": "2019-08-24T14:15:22Z",
"items": [{"item_id": "string",
"name": "string",
"quantity": 0,
"unitPrice": 0,
"total": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"additional_notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"relatedEntities": {"orderId": "string",
"supplierPricingRequestIds": ["string"
],
"internalCostCalculationId": "string",
"previousQuoteRequestId": "string"
},
"customFields": null,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
]

Retrieves a single resource with the given id from

Retrieves a single resource with the given id from the service.

path Parameters

_id

required

integer

ID of customerQuoteRequests to return

Responses

Request samples

Shell + Curl

curl --request GET \
  --url https://api.inkcloud9.com/customer-quote-requests/%7B_id%7D

Response samples

200

Content type

application/json

{"tenant": "string",
"humanId": 0,
"customer": "string",
"deleted": false,
"deletedAt": "2019-08-24T14:15:22Z",
"deletedBy": "string",
"deletedByModel": "user",
"title": "string",
"status": {"current": "Draft",
"history": [{"status": "string",
"changed_at": "2019-08-24T14:15:22Z",
"changed_by": "string",
"notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"urgency": "Standard",
"budget": {"min": 0,
"max": 0,
"currency": "USD",
"flexibility": "Strict"
},
"timeline": {"requestedQuoteByDate": "2019-08-24T14:15:22Z",
"requestedDelivery_date": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z"
},
"items": [{"name": "string",
"quantity": 0,
"category": {"category_id": "string",
"name": "string"
},
"description": "string",
"specifications": [{"spec_id": "string",
"name": "string",
"specType": "dimension",
"structured": {"value": null,
"unit": "string",
"option_id": "string"
},
"unstructured": "string",
"isRequired": false,
"displayOrder": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"itemAttachments": [{"attachedAt": "2019-08-24T14:15:22Z",
"filename": "string",
"size": "string",
"label": "string",
"uploadLog": "string",
"attachedBy": "string",
"attachedByModel": "user",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"shipping": {"addresses": [{"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"method": "string",
"instructions": "string"
},
"attachments": [{"attachedAt": "2019-08-24T14:15:22Z",
"filename": "string",
"size": "string",
"label": "string",
"uploadLog": "string",
"attachedBy": "string",
"attachedByModel": "user",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"notes": {"customerNotes": "string",
"internalNotes": "string",
"communicationHistory": [{"date": "2019-08-24T14:15:22Z",
"author_id": "string",
"author_type": "customer",
"message": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"quotation": {"quote_id": "string",
"quote_date": "2019-08-24T14:15:22Z",
"valid_until": "2019-08-24T14:15:22Z",
"subtotal": 0,
"tax": 0,
"shipping": 0,
"total": 0,
"estimated_delivery": "2019-08-24T14:15:22Z",
"items": [{"item_id": "string",
"name": "string",
"quantity": 0,
"unitPrice": 0,
"total": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"additional_notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"relatedEntities": {"orderId": "string",
"supplierPricingRequestIds": ["string"
],
"internalCostCalculationId": "string",
"previousQuoteRequestId": "string"
},
"customFields": null,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of customerQuoteRequests to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
humanId	number
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
deleted	boolean Default: false
deletedAt	string <date-time>
deletedBy	string^[0-9a-fA-F]{24}$
deletedByModel	string Enum: "user" "commandCenterUser" "micrositeCustomers"
title required	string
	object (status)
urgency	string Default: "Standard" Enum: "Standard" "Rush" "Critical"
	object (budget)
	object (timeline)
	Array of objects (itemOf_items)
	object (shipping)
	Array of objects (itemOf_attachments)
	object (notes)
	object (quotation)
	object (relatedEntities)
customFields	any
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload

Content type

application/json

{"tenant": "string",
"humanId": 0,
"customer": "string",
"deleted": false,
"deletedAt": "2019-08-24T14:15:22Z",
"deletedBy": "string",
"deletedByModel": "user",
"title": "string",
"status": {"current": "Draft",
"history": [{"status": "string",
"changed_at": "2019-08-24T14:15:22Z",
"changed_by": "string",
"notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"urgency": "Standard",
"budget": {"min": 0,
"max": 0,
"currency": "USD",
"flexibility": "Strict"
},
"timeline": {"requestedQuoteByDate": "2019-08-24T14:15:22Z",
"requestedDelivery_date": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z"
},
"items": [{"name": "string",
"quantity": 0,
"category": {"category_id": "string",
"name": "string"
},
"description": "string",
"specifications": [{"spec_id": "string",
"name": "string",
"specType": "dimension",
"structured": {"value": null,
"unit": "string",
"option_id": "string"
},
"unstructured": "string",
"isRequired": false,
"displayOrder": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"itemAttachments": [{"attachedAt": "2019-08-24T14:15:22Z",
"filename": "string",
"size": "string",
"label": "string",
"uploadLog": "string",
"attachedBy": "string",
"attachedByModel": "user",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"shipping": {"addresses": [{"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"method": "string",
"instructions": "string"
},
"attachments": [{"attachedAt": "2019-08-24T14:15:22Z",
"filename": "string",
"size": "string",
"label": "string",
"uploadLog": "string",
"attachedBy": "string",
"attachedByModel": "user",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"notes": {"customerNotes": "string",
"internalNotes": "string",
"communicationHistory": [{"date": "2019-08-24T14:15:22Z",
"author_id": "string",
"author_type": "customer",
"message": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"quotation": {"quote_id": "string",
"quote_date": "2019-08-24T14:15:22Z",
"valid_until": "2019-08-24T14:15:22Z",
"subtotal": 0,
"tax": 0,
"shipping": 0,
"total": 0,
"estimated_delivery": "2019-08-24T14:15:22Z",
"items": [{"item_id": "string",
"name": "string",
"quantity": 0,
"unitPrice": 0,
"total": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"additional_notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"relatedEntities": {"orderId": "string",
"supplierPricingRequestIds": ["string"
],
"internalCostCalculationId": "string",
"previousQuoteRequestId": "string"
},
"customFields": null,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Response samples

200

Content type

application/json

{"tenant": "string",
"humanId": 0,
"customer": "string",
"deleted": false,
"deletedAt": "2019-08-24T14:15:22Z",
"deletedBy": "string",
"deletedByModel": "user",
"title": "string",
"status": {"current": "Draft",
"history": [{"status": "string",
"changed_at": "2019-08-24T14:15:22Z",
"changed_by": "string",
"notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"urgency": "Standard",
"budget": {"min": 0,
"max": 0,
"currency": "USD",
"flexibility": "Strict"
},
"timeline": {"requestedQuoteByDate": "2019-08-24T14:15:22Z",
"requestedDelivery_date": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z"
},
"items": [{"name": "string",
"quantity": 0,
"category": {"category_id": "string",
"name": "string"
},
"description": "string",
"specifications": [{"spec_id": "string",
"name": "string",
"specType": "dimension",
"structured": {"value": null,
"unit": "string",
"option_id": "string"
},
"unstructured": "string",
"isRequired": false,
"displayOrder": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"itemAttachments": [{"attachedAt": "2019-08-24T14:15:22Z",
"filename": "string",
"size": "string",
"label": "string",
"uploadLog": "string",
"attachedBy": "string",
"attachedByModel": "user",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"shipping": {"addresses": [{"name": "string",
"careOf": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateProvince": "string",
"postalCode": "string",
"countryCode": "string",
"deliveryInstructions": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"method": "string",
"instructions": "string"
},
"attachments": [{"attachedAt": "2019-08-24T14:15:22Z",
"filename": "string",
"size": "string",
"label": "string",
"uploadLog": "string",
"attachedBy": "string",
"attachedByModel": "user",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"notes": {"customerNotes": "string",
"internalNotes": "string",
"communicationHistory": [{"date": "2019-08-24T14:15:22Z",
"author_id": "string",
"author_type": "customer",
"message": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"quotation": {"quote_id": "string",
"quote_date": "2019-08-24T14:15:22Z",
"valid_until": "2019-08-24T14:15:22Z",
"subtotal": 0,
"tax": 0,
"shipping": 0,
"total": 0,
"estimated_delivery": "2019-08-24T14:15:22Z",
"items": [{"item_id": "string",
"name": "string",
"quantity": 0,
"unitPrice": 0,
"total": 0,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"additional_notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"relatedEntities": {"orderId": "string",
"supplierPricingRequestIds": ["string"
],
"internalCostCalculationId": "string",
"previousQuoteRequestId": "string"
},
"customFields": null,
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Updates the resource identified by id using data.

path Parameters

_id

required

integer

ID of customerQuoteRequests to update

Request Body schema: application/json

tenant required	string^[0-9a-fA-F]{24}$ Refers to tenants
humanId	number
customer required	string^[0-9a-fA-F]{24}$ Refers to customers
deleted	boolean Default: false
deletedAt	string <date-time>
deletedBy	string^[0-9a-fA-F]{24}$
deletedByModel	string Enum: "user" "commandCenterUser" "micrositeCustomers"
title required	string
	object (status)
urgency	string Default: "Standard" Enum: "Standard" "Rush" "Critical"
	object (budget)
	object (timeline)
	Array of objects (itemOf_items)
	object (shipping)
	Array of objects (itemOf_attachments)
	object (notes)
	object (quotation)
	object (relatedEntities)
customFields	any
_id	string^[0-9a-fA-F]{24}$
createdAt	string <date-time>
updatedAt	string <date-time>
__v	number

Responses

Request samples

Payload
Shell + Curl

Content type

application/json

{"tenant": "string",
"humanId": 0,
"customer": "string",
"deleted": false,
"deletedAt": "2019-08-24T14:15:22Z",
"deletedBy": "string",
"deletedByModel": "user",
"title": "string",
"status": {"current": "Draft",
"history": [{"status": "string",
"changed_at": "2019-08-24T14:15:22Z",
"changed_by": "string",
"notes": "string",
"_id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
},
"urgency": "Standard",
"budget":