Skip to main content

Workspaces

What you can do with Workspace#

Workspace Properties#

team
REQUIRED

Type: string (format: iri-reference)

title
REQUIRED

Type: string

defaultTrackingPage
REQUIRED

Type: string|null (format: iri-reference)

shipmentsCount

Type: integer|null

workflowsCount

Type: integer|null

workflowsOrder

Type: array

logo

Type: object|null

Example:
"logo": {
  "id": "string",
  "filePath": "string"
}
  • id:
  • filePath:

    https://s3-test.trackmage.com/media/a4f29b34-aa67-4e68-a7c8-f1c2e081979e/5dfa6dfcc161f_cats.png TODO: prepend this with PublicUrlPlugin in a normalizer, and remove IMG_URL on frontend.

emailSettings

Type: object

Example:
"emailSettings": {
  "logo": {
    "id": "string",
    "filePath": "string"
  },
  "signature": "string|null",
  "smtpCredentials": "string|null"
}
  • logo:
  • signature:
  • smtpCredentials:

id
READ-ONLY

Type: string (format: uuid)

Endpoints#

GET
/workspaces
Retrieves the collection of Workspace resources.
Query Parameters
NameInIs RequiredTypeDescription
order[createdAt]queryNostring
Allowed values: asc|desc
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
GET
/workspaces/{id}
Retrieves a Workspace resource.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
GET
/workspaces/{id}/notes
Retrieves the collection of Note resources.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
entityqueryNostring
entity[]queryNoarray
Array of Strings.
entityIdqueryNostring
entityId[]queryNoarray
Array of Strings.
order[createdAt]queryNostring
Allowed values: asc|desc
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
GET
/teams/{id}/workspaces
Retrieves the collection of Workspace resources.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
order[createdAt]queryNostring
Allowed values: asc|desc
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
GET
/workspaces/{id}/orders
Retrieves the collection of Order resources.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
order[id]queryNostring
Allowed values: asc|desc
order[orderNumber]queryNostring
Allowed values: asc|desc
order[email]queryNostring
Allowed values: asc|desc
order[phoneNumber]queryNostring
Allowed values: asc|desc
order[orderStatus.code]queryNostring
Allowed values: asc|desc
order[subtotal]queryNostring
Allowed values: asc|desc
order[total]queryNostring
Allowed values: asc|desc
order[createdAt]queryNostring
Allowed values: asc|desc
order[updatedAt]queryNostring
Allowed values: asc|desc
order[shippingAddress.addressLine1]queryNostring
Allowed values: asc|desc
order[shippingAddress.addressLine2]queryNostring
Allowed values: asc|desc
order[shippingAddress.city]queryNostring
Allowed values: asc|desc
order[shippingAddress.company]queryNostring
Allowed values: asc|desc
order[shippingAddress.countryIso2]queryNostring
Allowed values: asc|desc
order[shippingAddress.firstName]queryNostring
Allowed values: asc|desc
order[shippingAddress.lastName]queryNostring
Allowed values: asc|desc
order[shippingAddress.postcode]queryNostring
Allowed values: asc|desc
order[shippingAddress.state]queryNostring
Allowed values: asc|desc
order[billingAddress.addressLine1]queryNostring
Allowed values: asc|desc
order[billingAddress.addressLine2]queryNostring
Allowed values: asc|desc
order[billingAddress.city]queryNostring
Allowed values: asc|desc
order[billingAddress.company]queryNostring
Allowed values: asc|desc
order[billingAddress.countryIso2]queryNostring
Allowed values: asc|desc
order[billingAddress.firstName]queryNostring
Allowed values: asc|desc
order[billingAddress.lastName]queryNostring
Allowed values: asc|desc
order[billingAddress.postcode]queryNostring
Allowed values: asc|desc
order[billingAddress.state]queryNostring
Allowed values: asc|desc
order[fulfillmentStatus]queryNostring
Allowed values: asc|desc
createdAt[before]queryNostring
createdAt[strictly_before]queryNostring
createdAt[after]queryNostring
createdAt[strictly_after]queryNostring
updatedAt[before]queryNostring
updatedAt[strictly_before]queryNostring
updatedAt[after]queryNostring
updatedAt[strictly_after]queryNostring
id[]queryNoarray
Array of Strings.
orderNumberqueryNostring
emailqueryNostring
phoneNumberqueryNostring
orderStatus.codequeryNostring
orderStatus.code[]queryNoarray
Array of Strings.
orderTypequeryNostring
orderType[]queryNoarray
Array of Strings.
shippingAddress.addressLine1queryNostring
shippingAddress.addressLine2queryNostring
shippingAddress.cityqueryNostring
shippingAddress.companyqueryNostring
shippingAddress.countryIso2queryNostring
shippingAddress.countryIso2[]queryNoarray
Array of Strings.
shippingAddress.firstNamequeryNostring
shippingAddress.lastNamequeryNostring
shippingAddress.postcodequeryNostring
shippingAddress.statequeryNostring
billingAddress.addressLine1queryNostring
billingAddress.addressLine2queryNostring
billingAddress.cityqueryNostring
billingAddress.companyqueryNostring
billingAddress.countryIso2queryNostring
billingAddress.countryIso2[]queryNoarray
Array of Strings.
billingAddress.firstNamequeryNostring
billingAddress.lastNamequeryNostring
billingAddress.postcodequeryNostring
billingAddress.statequeryNostring
fulfillmentStatusqueryNostring
fulfillmentStatus[]queryNoarray
Array of Strings.
subtotalqueryNostring
subtotal[]queryNoarray
Array of Strings.
totalqueryNostring
total[]queryNoarray
Array of Strings.
subtotal[between]queryNostring
subtotal[gt]queryNostring
subtotal[gte]queryNostring
subtotal[lt]queryNostring
subtotal[lte]queryNostring
total[between]queryNostring
total[gt]queryNostring
total[gte]queryNostring
total[lt]queryNostring
total[lte]queryNostring
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
GET
/workspaces/{id}/statuses
Retrieves the collection of Status resources.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
entityqueryNostring
codequeryNostring
titlequeryNostring
order[entity]queryNostring
Allowed values: asc|desc
order[code]queryNostring
Allowed values: asc|desc
order[title]queryNostring
Allowed values: asc|desc
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
GET
/workspaces/{id}/workflows
Retrieves the collection of Workflow resources.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
typequeryNostring
type[]queryNoarray
Array of Strings.
periodqueryNostring
period[]queryNoarray
Array of Strings.
titlequeryNostring
order[createdAt]queryNostring
Allowed values: asc|desc
tagqueryNostring
exists[integration]queryNoboolean
firstTimeSetupPassedqueryNoboolean
first_time_setup_requiredqueryNostring
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
GET
/workspaces/{id}/shipments
Retrieves the collection of Shipment resources.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
order[id]queryNostring
Allowed values: asc|desc
order[trackingNumber]queryNostring
Allowed values: asc|desc
order[trackingStatus]queryNostring
Allowed values: asc|desc
order[shipmentStatus.code]queryNostring
Allowed values: asc|desc
order[originCarrier]queryNostring
Allowed values: asc|desc
order[destinationCarrier]queryNostring
Allowed values: asc|desc
order[createdAt]queryNostring
Allowed values: asc|desc
order[updatedAt]queryNostring
Allowed values: asc|desc
order[shippedAt]queryNostring
Allowed values: asc|desc
order[lastStatusUpdate]queryNostring
Allowed values: asc|desc
order[expectedDeliveryDate]queryNostring
Allowed values: asc|desc
order[originCountry]queryNostring
Allowed values: asc|desc
order[destinationCountry]queryNostring
Allowed values: asc|desc
order[originCountryIso2]queryNostring
Allowed values: asc|desc
order[destinationCountryIso2]queryNostring
Allowed values: asc|desc
order[email]queryNostring
Allowed values: asc|desc
order[phoneNumber]queryNostring
Allowed values: asc|desc
order[daysInTransit]queryNostring
Allowed values: asc|desc
order[reviewTotalScore]queryNostring
Allowed values: asc|desc
order[address.addressLine1]queryNostring
Allowed values: asc|desc
order[address.addressLine2]queryNostring
Allowed values: asc|desc
order[address.city]queryNostring
Allowed values: asc|desc
order[address.company]queryNostring
Allowed values: asc|desc
order[address.countryIso2]queryNostring
Allowed values: asc|desc
order[address.firstName]queryNostring
Allowed values: asc|desc
order[address.lastName]queryNostring
Allowed values: asc|desc
order[address.postcode]queryNostring
Allowed values: asc|desc
order[address.state]queryNostring
Allowed values: asc|desc
orderNumbersqueryNostring
orderNumbers[]queryNoarray
Array of Strings.
createdAt[before]queryNostring
createdAt[strictly_before]queryNostring
createdAt[after]queryNostring
createdAt[strictly_after]queryNostring
updatedAt[before]queryNostring
updatedAt[strictly_before]queryNostring
updatedAt[after]queryNostring
updatedAt[strictly_after]queryNostring
shippedAt[before]queryNostring
shippedAt[strictly_before]queryNostring
shippedAt[after]queryNostring
shippedAt[strictly_after]queryNostring
lastStatusUpdate[before]queryNostring
lastStatusUpdate[strictly_before]queryNostring
lastStatusUpdate[after]queryNostring
lastStatusUpdate[strictly_after]queryNostring
expectedDeliveryDate[before]queryNostring
expectedDeliveryDate[strictly_before]queryNostring
expectedDeliveryDate[after]queryNostring
expectedDeliveryDate[strictly_after]queryNostring
id[]queryNoarray
Array of Strings.
trackingNumberqueryNostring
trackingStatusqueryNostring
trackingStatus[]queryNoarray
Array of Strings.
shipmentStatus.codequeryNostring
shipmentStatus.code[]queryNoarray
Array of Strings.
originCarrierqueryNostring
originCarrier[]queryNoarray
Array of Strings.
destinationCarrierqueryNostring
destinationCarrier[]queryNoarray
Array of Strings.
originCountryqueryNostring
originCountryIso2queryNostring
originCountryIso2[]queryNoarray
Array of Strings.
destinationCountryqueryNostring
destinationCountryIso2queryNostring
destinationCountryIso2[]queryNoarray
Array of Strings.
emailqueryNostring
phoneNumberqueryNostring
address.addressLine1queryNostring
address.addressLine2queryNostring
address.cityqueryNostring
address.companyqueryNostring
address.countryIso2queryNostring
address.countryIso2[]queryNoarray
Array of Strings.
address.firstNamequeryNostring
address.lastNamequeryNostring
address.postcodequeryNostring
address.statequeryNostring
daysInTransitqueryNointeger
daysInTransit[]queryNoarray
Array of Integers.
daysInTransit[between]queryNostring
daysInTransit[gt]queryNostring
daysInTransit[gte]queryNostring
daysInTransit[lt]queryNostring
daysInTransit[lte]queryNostring
reviewTotalScore[between]queryNostring
reviewTotalScore[gt]queryNostring
reviewTotalScore[gte]queryNostring
reviewTotalScore[lt]queryNostring
reviewTotalScore[lte]queryNostring
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
GET
/workspaces/{id}/tracking_pages
Retrieves the collection of TrackingPage resources.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
GET
/workspaces/{id}/email_notifications
Retrieves the collection of EmailNotification resources.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
id[]queryNoarray
Array of Strings.
eventqueryNostring
event[]queryNoarray
Array of Strings.
createdAt[before]queryNostring
createdAt[strictly_before]queryNostring
createdAt[after]queryNostring
createdAt[strictly_after]queryNostring
lastEmailSentAt[before]queryNostring
lastEmailSentAt[strictly_before]queryNostring
lastEmailSentAt[after]queryNostring
lastEmailSentAt[strictly_after]queryNostring
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
GET
/teams/{id}/workspaces/{workspaces}/notes
Retrieves the collection of Note resources.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
workspacespathYesstring
entityqueryNostring
entity[]queryNoarray
Array of Strings.
entityIdqueryNostring
entityId[]queryNoarray
Array of Strings.
order[createdAt]queryNostring
Allowed values: asc|desc
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
GET
/teams/{id}/workspaces/{workspaces}/orders
Retrieves the collection of Order resources.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
workspacespathYesstring
order[id]queryNostring
Allowed values: asc|desc
order[orderNumber]queryNostring
Allowed values: asc|desc
order[email]queryNostring
Allowed values: asc|desc
order[phoneNumber]queryNostring
Allowed values: asc|desc
order[orderStatus.code]queryNostring
Allowed values: asc|desc
order[subtotal]queryNostring
Allowed values: asc|desc
order[total]queryNostring
Allowed values: asc|desc
order[createdAt]queryNostring
Allowed values: asc|desc
order[updatedAt]queryNostring
Allowed values: asc|desc
order[shippingAddress.addressLine1]queryNostring
Allowed values: asc|desc
order[shippingAddress.addressLine2]queryNostring
Allowed values: asc|desc
order[shippingAddress.city]queryNostring
Allowed values: asc|desc
order[shippingAddress.company]queryNostring
Allowed values: asc|desc
order[shippingAddress.countryIso2]queryNostring
Allowed values: asc|desc
order[shippingAddress.firstName]queryNostring
Allowed values: asc|desc
order[shippingAddress.lastName]queryNostring
Allowed values: asc|desc
order[shippingAddress.postcode]queryNostring
Allowed values: asc|desc
order[shippingAddress.state]queryNostring
Allowed values: asc|desc
order[billingAddress.addressLine1]queryNostring
Allowed values: asc|desc
order[billingAddress.addressLine2]queryNostring
Allowed values: asc|desc
order[billingAddress.city]queryNostring
Allowed values: asc|desc
order[billingAddress.company]queryNostring
Allowed values: asc|desc
order[billingAddress.countryIso2]queryNostring
Allowed values: asc|desc
order[billingAddress.firstName]queryNostring
Allowed values: asc|desc
order[billingAddress.lastName]queryNostring
Allowed values: asc|desc
order[billingAddress.postcode]queryNostring
Allowed values: asc|desc
order[billingAddress.state]queryNostring
Allowed values: asc|desc
order[fulfillmentStatus]queryNostring
Allowed values: asc|desc
createdAt[before]queryNostring
createdAt[strictly_before]queryNostring
createdAt[after]queryNostring
createdAt[strictly_after]queryNostring
updatedAt[before]queryNostring
updatedAt[strictly_before]queryNostring
updatedAt[after]queryNostring
updatedAt[strictly_after]queryNostring
id[]queryNoarray
Array of Strings.
orderNumberqueryNostring
emailqueryNostring
phoneNumberqueryNostring
orderStatus.codequeryNostring
orderStatus.code[]queryNoarray
Array of Strings.
orderTypequeryNostring
orderType[]queryNoarray
Array of Strings.
shippingAddress.addressLine1queryNostring
shippingAddress.addressLine2queryNostring
shippingAddress.cityqueryNostring
shippingAddress.companyqueryNostring
shippingAddress.countryIso2queryNostring
shippingAddress.countryIso2[]queryNoarray
Array of Strings.
shippingAddress.firstNamequeryNostring
shippingAddress.lastNamequeryNostring
shippingAddress.postcodequeryNostring
shippingAddress.statequeryNostring
billingAddress.addressLine1queryNostring
billingAddress.addressLine2queryNostring
billingAddress.cityqueryNostring
billingAddress.companyqueryNostring
billingAddress.countryIso2queryNostring
billingAddress.countryIso2[]queryNoarray
Array of Strings.
billingAddress.firstNamequeryNostring
billingAddress.lastNamequeryNostring
billingAddress.postcodequeryNostring
billingAddress.statequeryNostring
fulfillmentStatusqueryNostring
fulfillmentStatus[]queryNoarray
Array of Strings.
subtotalqueryNostring
subtotal[]queryNoarray
Array of Strings.
totalqueryNostring
total[]queryNoarray
Array of Strings.
subtotal[between]queryNostring
subtotal[gt]queryNostring
subtotal[gte]queryNostring
subtotal[lt]queryNostring
subtotal[lte]queryNostring
total[between]queryNostring
total[gt]queryNostring
total[gte]queryNostring
total[lt]queryNostring
total[lte]queryNostring
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
GET
/teams/{id}/workspaces/{workspaces}/statuses
Retrieves the collection of Status resources.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
workspacespathYesstring
entityqueryNostring
codequeryNostring
titlequeryNostring
order[entity]queryNostring
Allowed values: asc|desc
order[code]queryNostring
Allowed values: asc|desc
order[title]queryNostring
Allowed values: asc|desc
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
GET
/teams/{id}/workspaces/{workspaces}/workflows
Retrieves the collection of Workflow resources.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
workspacespathYesstring
typequeryNostring
type[]queryNoarray
Array of Strings.
periodqueryNostring
period[]queryNoarray
Array of Strings.
titlequeryNostring
order[createdAt]queryNostring
Allowed values: asc|desc
tagqueryNostring
exists[integration]queryNoboolean
firstTimeSetupPassedqueryNoboolean
first_time_setup_requiredqueryNostring
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
GET
/teams/{id}/workspaces/{workspaces}/shipments
Retrieves the collection of Shipment resources.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
workspacespathYesstring
order[id]queryNostring
Allowed values: asc|desc
order[trackingNumber]queryNostring
Allowed values: asc|desc
order[trackingStatus]queryNostring
Allowed values: asc|desc
order[shipmentStatus.code]queryNostring
Allowed values: asc|desc
order[originCarrier]queryNostring
Allowed values: asc|desc
order[destinationCarrier]queryNostring
Allowed values: asc|desc
order[createdAt]queryNostring
Allowed values: asc|desc
order[updatedAt]queryNostring
Allowed values: asc|desc
order[shippedAt]queryNostring
Allowed values: asc|desc
order[lastStatusUpdate]queryNostring
Allowed values: asc|desc
order[expectedDeliveryDate]queryNostring
Allowed values: asc|desc
order[originCountry]queryNostring
Allowed values: asc|desc
order[destinationCountry]queryNostring
Allowed values: asc|desc
order[originCountryIso2]queryNostring
Allowed values: asc|desc
order[destinationCountryIso2]queryNostring
Allowed values: asc|desc
order[email]queryNostring
Allowed values: asc|desc
order[phoneNumber]queryNostring
Allowed values: asc|desc
order[daysInTransit]queryNostring
Allowed values: asc|desc
order[reviewTotalScore]queryNostring
Allowed values: asc|desc
order[address.addressLine1]queryNostring
Allowed values: asc|desc
order[address.addressLine2]queryNostring
Allowed values: asc|desc
order[address.city]queryNostring
Allowed values: asc|desc
order[address.company]queryNostring
Allowed values: asc|desc
order[address.countryIso2]queryNostring
Allowed values: asc|desc
order[address.firstName]queryNostring
Allowed values: asc|desc
order[address.lastName]queryNostring
Allowed values: asc|desc
order[address.postcode]queryNostring
Allowed values: asc|desc
order[address.state]queryNostring
Allowed values: asc|desc
orderNumbersqueryNostring
orderNumbers[]queryNoarray
Array of Strings.
createdAt[before]queryNostring
createdAt[strictly_before]queryNostring
createdAt[after]queryNostring
createdAt[strictly_after]queryNostring
updatedAt[before]queryNostring
updatedAt[strictly_before]queryNostring
updatedAt[after]queryNostring
updatedAt[strictly_after]queryNostring
shippedAt[before]queryNostring
shippedAt[strictly_before]queryNostring
shippedAt[after]queryNostring
shippedAt[strictly_after]queryNostring
lastStatusUpdate[before]queryNostring
lastStatusUpdate[strictly_before]queryNostring
lastStatusUpdate[after]queryNostring
lastStatusUpdate[strictly_after]queryNostring
expectedDeliveryDate[before]queryNostring
expectedDeliveryDate[strictly_before]queryNostring
expectedDeliveryDate[after]queryNostring
expectedDeliveryDate[strictly_after]queryNostring
id[]queryNoarray
Array of Strings.
trackingNumberqueryNostring
trackingStatusqueryNostring
trackingStatus[]queryNoarray
Array of Strings.
shipmentStatus.codequeryNostring
shipmentStatus.code[]queryNoarray
Array of Strings.
originCarrierqueryNostring
originCarrier[]queryNoarray
Array of Strings.
destinationCarrierqueryNostring
destinationCarrier[]queryNoarray
Array of Strings.
originCountryqueryNostring
originCountryIso2queryNostring
originCountryIso2[]queryNoarray
Array of Strings.
destinationCountryqueryNostring
destinationCountryIso2queryNostring
destinationCountryIso2[]queryNoarray
Array of Strings.
emailqueryNostring
phoneNumberqueryNostring
address.addressLine1queryNostring
address.addressLine2queryNostring
address.cityqueryNostring
address.companyqueryNostring
address.countryIso2queryNostring
address.countryIso2[]queryNoarray
Array of Strings.
address.firstNamequeryNostring
address.lastNamequeryNostring
address.postcodequeryNostring
address.statequeryNostring
daysInTransitqueryNointeger
daysInTransit[]queryNoarray
Array of Integers.
daysInTransit[between]queryNostring
daysInTransit[gt]queryNostring
daysInTransit[gte]queryNostring
daysInTransit[lt]queryNostring
daysInTransit[lte]queryNostring
reviewTotalScore[between]queryNostring
reviewTotalScore[gt]queryNostring
reviewTotalScore[gte]queryNostring
reviewTotalScore[lt]queryNostring
reviewTotalScore[lte]queryNostring
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
GET
/teams/{id}/workspaces/{workspaces}/tracking_pages
Retrieves the collection of TrackingPage resources.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
workspacespathYesstring
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
GET
/teams/{id}/workspaces/{workspaces}/email_notifications
Retrieves the collection of EmailNotification resources.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
workspacespathYesstring
id[]queryNoarray
Array of Strings.
eventqueryNostring
event[]queryNoarray
Array of Strings.
createdAt[before]queryNostring
createdAt[strictly_before]queryNostring
createdAt[after]queryNostring
createdAt[strictly_after]queryNostring
lastEmailSentAt[before]queryNostring
lastEmailSentAt[strictly_before]queryNostring
lastEmailSentAt[after]queryNostring
lastEmailSentAt[strictly_after]queryNostring
pagequeryNointegerThe collection page number
The default value: 1
itemsPerPagequeryNointegerThe number of items per page
The default value: 30
The minimal value: 0
POST
/workspaces
Creates a Workspace resource.
Request Body Parameters

team
REQUIRED

Type: object

Example:
"team": {
  "name": "string|null"
}
  • name:

title
REQUIRED

Type: string

defaultTrackingPage
REQUIRED

Type: object|null

Example:
"defaultTrackingPage": {
  "enabled": "boolean",
  "reviewsEnabled": "boolean",
  "title": "string|null",
  "subdomain": "string",
  "domain": "string|null",
  "sidebarField": "string|null",
  "trackingNumberField": "string|null",
  "builder": "{}",
  "dropshipperSettings": "{}"
}
  • enabled:
  • reviewsEnabled:
  • title:
  • subdomain:
  • domain:
  • sidebarField:
  • trackingNumberField:
  • builder:
  • dropshipperSettings:

workflowsOrder

Type: array

logo

Type: string|null (format: iri-reference)

emailSettings

Type: object

Example:
"emailSettings": {
  "logo": "string|null",
  "signature": "string|null",
  "smtpCredentials": "string|null"
}
  • logo:
  • signature:
  • smtpCredentials:
PUT
/workspaces/{id}
Replaces the Workspace resource.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring
Request Body Parameters

title
REQUIRED

Type: string

defaultTrackingPage
REQUIRED

Type: object|null

Example:
"defaultTrackingPage": {
  "enabled": "boolean",
  "reviewsEnabled": "boolean",
  "title": "string|null",
  "subdomain": "string",
  "domain": "string|null",
  "sidebarField": "string|null",
  "trackingNumberField": "string|null",
  "builder": "{}",
  "dropshipperSettings": "{}"
}
  • enabled:
  • reviewsEnabled:
  • title:
  • subdomain:
  • domain:
  • sidebarField:
  • trackingNumberField:
  • builder:
  • dropshipperSettings:

workflowsOrder

Type: array

logo

Type: string|null (format: iri-reference)

emailSettings

Type: object

Example:
"emailSettings": {
  "logo": "string|null",
  "signature": "string|null",
  "smtpCredentials": "string|null"
}
  • logo:
  • signature:
  • smtpCredentials:
DELETE
/workspaces/{id}
Removes the Workspace resource.
Query Parameters
NameInIs RequiredTypeDescription
idpathYesstring