Workspaces
What you can do with Workspace
Workspace Properties
team | Type: string (format: iri-reference) |
title | Type: string |
defaultTrackingPage | 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" }
|
emailSettings | Type: object Example:"emailSettings": { "logo": { "id": "string", "filePath": "string" }, "signature": "string|null", "smtpCredentials": "string|null" }
|
widgets | Type: array |
scheduledForDelete | Type: boolean|null |
id | Type: string (format: uuid) |
Endpoints
Name | In | Is Required | Type | Description |
---|---|---|---|---|
page | query | No | integer | The collection page number The default value: 1 |
itemsPerPage | query | No | integer | The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500 |
order[createdAt] | query | No | string | Allowed values: asc|desc |
Name | In | Is Required | Type | Description |
---|---|---|---|---|
id | path | Yes | string | Resource identifier |
Name | In | Is Required | Type | Description |
---|---|---|---|---|
id | path | Yes | string | Workspace identifier |
page | query | No | integer | The collection page number The default value: 1 |
itemsPerPage | query | No | integer | The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500 |
entity | query | No | string | |
entity[] | query | No | array | Array of Strings. |
entityId | query | No | string | |
entityId[] | query | No | array | Array of Strings. |
order[createdAt] | query | No | string | Allowed values: asc|desc |
Name | In | Is Required | Type | Description |
---|---|---|---|---|
id | path | Yes | string | Team identifier |
page | query | No | integer | The collection page number The default value: 1 |
itemsPerPage | query | No | integer | The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500 |
order[createdAt] | query | No | string | Allowed values: asc|desc |
Name | In | Is Required | Type | Description |
---|---|---|---|---|
id | path | Yes | string | Workspace identifier |
page | query | No | integer | The collection page number The default value: 1 |
itemsPerPage | query | No | integer | The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500 |
order[id] | query | No | string | Allowed values: asc|desc |
order[orderNumber] | query | No | string | Allowed values: asc|desc |
order[email] | query | No | string | Allowed values: asc|desc |
order[phoneNumber] | query | No | string | Allowed values: asc|desc |
order[orderStatus.code] | query | No | string | Allowed values: asc|desc |
order[subtotal] | query | No | string | Allowed values: asc|desc |
order[total] | query | No | string | Allowed values: asc|desc |
order[createdAt] | query | No | string | Allowed values: asc|desc |
order[updatedAt] | query | No | string | Allowed values: asc|desc |
order[shippingAddress.addressLine1] | query | No | string | Allowed values: asc|desc |
order[shippingAddress.addressLine2] | query | No | string | Allowed values: asc|desc |
order[shippingAddress.city] | query | No | string | Allowed values: asc|desc |
order[shippingAddress.company] | query | No | string | Allowed values: asc|desc |
order[shippingAddress.countryIso2] | query | No | string | Allowed values: asc|desc |
order[shippingAddress.firstName] | query | No | string | Allowed values: asc|desc |
order[shippingAddress.lastName] | query | No | string | Allowed values: asc|desc |
order[shippingAddress.postcode] | query | No | string | Allowed values: asc|desc |
order[shippingAddress.state] | query | No | string | Allowed values: asc|desc |
order[billingAddress.addressLine1] | query | No | string | Allowed values: asc|desc |
order[billingAddress.addressLine2] | query | No | string | Allowed values: asc|desc |
order[billingAddress.city] | query | No | string | Allowed values: asc|desc |
order[billingAddress.company] | query | No | string | Allowed values: asc|desc |
order[billingAddress.countryIso2] | query | No | string | Allowed values: asc|desc |
order[billingAddress.firstName] | query | No | string | Allowed values: asc|desc |
order[billingAddress.lastName] | query | No | string | Allowed values: asc|desc |
order[billingAddress.postcode] | query | No | string | Allowed values: asc|desc |
order[billingAddress.state] | query | No | string | Allowed values: asc|desc |
order[fulfillmentStatus] | query | No | string | Allowed values: asc|desc |
order[shipmentsWithoutTrackingCount] | query | No | string | Allowed values: asc|desc |
createdAt[before] | query | No | string | |
createdAt[strictly_before] | query | No | string | |
createdAt[after] | query | No | string | |
createdAt[strictly_after] | query | No | string | |
updatedAt[before] | query | No | string | |
updatedAt[strictly_before] | query | No | string | |
updatedAt[after] | query | No | string | |
updatedAt[strictly_after] | query | No | string | |
id | query | No | string | |
id[] | query | No | array | Array of Strings. |
orderNumber | query | No | string | |
query | No | string | ||
phoneNumber | query | No | string | |
orderStatus.code | query | No | string | |
orderStatus.code[] | query | No | array | Array of Strings. |
orderType | query | No | string | |
orderType[] | query | No | array | Array of Strings. |
shippingAddress.addressLine1 | query | No | string | |
shippingAddress.addressLine2 | query | No | string | |
shippingAddress.city | query | No | string | |
shippingAddress.company | query | No | string | |
shippingAddress.countryIso2 | query | No | string | |
shippingAddress.countryIso2[] | query | No | array | Array of Strings. |
shippingAddress.firstName | query | No | string | |
shippingAddress.lastName | query | No | string | |
shippingAddress.postcode | query | No | string | |
shippingAddress.state | query | No | string | |
billingAddress.addressLine1 | query | No | string | |
billingAddress.addressLine2 | query | No | string | |
billingAddress.city | query | No | string | |
billingAddress.company | query | No | string | |
billingAddress.countryIso2 | query | No | string | |
billingAddress.countryIso2[] | query | No | array | Array of Strings. |
billingAddress.firstName | query | No | string | |
billingAddress.lastName | query | No | string | |
billingAddress.postcode | query | No | string | |
billingAddress.state | query | No | string | |
fulfillmentStatus | query | No | string | |
fulfillmentStatus[] | query | No | array | Array of Strings. |
currency | query | No | string | |
subtotal | query | No | string | |
subtotal[] | query | No | array | Array of Strings. |
total | query | No | string | |
total[] | query | No | array | Array of Strings. |
shipmentsWithoutTrackingCount | query | No | integer | |
shipmentsWithoutTrackingCount[] | query | No | array | Array of Integers. |
subtotal[between] | query | No | string | |
subtotal[gt] | query | No | string | |
subtotal[gte] | query | No | string | |
subtotal[lt] | query | No | string | |
subtotal[lte] | query | No | string | |
total[between] | query | No | string | |
total[gt] | query | No | string | |
total[gte] | query | No | string | |
total[lt] | query | No | string | |
total[lte] | query | No | string | |
shipmentsWithoutTrackingCount[between] | query | No | string | |
shipmentsWithoutTrackingCount[gt] | query | No | string | |
shipmentsWithoutTrackingCount[gte] | query | No | string | |
shipmentsWithoutTrackingCount[lt] | query | No | string | |
shipmentsWithoutTrackingCount[lte] | query | No | string | |
empty[orderNumber] | query | No | boolean | |
empty[currency] | query | No | boolean | |
empty[email] | query | No | boolean | |
empty[phoneNumber] | query | No | boolean | |
empty[shippingAddress.addressLine1] | query | No | boolean | |
empty[shippingAddress.addressLine2] | query | No | boolean | |
empty[shippingAddress.city] | query | No | boolean | |
empty[shippingAddress.company] | query | No | boolean | |
empty[shippingAddress.firstName] | query | No | boolean | |
empty[shippingAddress.lastName] | query | No | boolean | |
empty[shippingAddress.postcode] | query | No | boolean | |
empty[shippingAddress.state] | query | No | boolean | |
empty[billingAddress.addressLine1] | query | No | boolean | |
empty[billingAddress.addressLine2] | query | No | boolean | |
empty[billingAddress.city] | query | No | boolean | |
empty[billingAddress.company] | query | No | boolean | |
empty[billingAddress.firstName] | query | No | boolean | |
empty[billingAddress.lastName] | query | No | boolean | |
empty[billingAddress.postcode] | query | No | boolean | |
empty[billingAddress.state] | query | No | boolean | |
groups[] | query | No | array | Array of Strings. |
Name | In | Is Required | Type | Description |
---|---|---|---|---|
id | path | Yes | string | Workspace identifier |
page | query | No | integer | The collection page number The default value: 1 |
itemsPerPage | query | No | integer | The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500 |
Name | In | Is Required | Type | Description |
---|---|---|---|---|
id | path | Yes | string | Workspace identifier |
page | query | No | integer | The collection page number The default value: 1 |
itemsPerPage | query | No | integer | The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500 |
entity | query | No | string | |
code | query | No | string | |
title | query | No | string | |
order[entity] | query | No | string | Allowed values: asc|desc |
order[code] | query | No | string | Allowed values: asc|desc |
order[title] | query | No | string | Allowed values: asc|desc |
Name | In | Is Required | Type | Description |
---|---|---|---|---|
id | path | Yes | string | Workspace identifier |
page | query | No | integer | The collection page number The default value: 1 |
itemsPerPage | query | No | integer | The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500 |
type | query | No | string | |
type[] | query | No | array | Array of Strings. |
period | query | No | string | |
period[] | query | No | array | Array of Strings. |
title | query | No | string | |
order[createdAt] | query | No | string | Allowed values: asc|desc |
tag | query | No | string | |
exists[integration] | query | No | boolean | |
firstTimeSetupPassed | query | No | boolean | |
first_time_setup_required | query | No | string |
Name | In | Is Required | Type | Description |
---|---|---|---|---|
id | path | Yes | string | Workspace identifier |
page | query | No | integer | The collection page number The default value: 1 |
itemsPerPage | query | No | integer | The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500 |
order[id] | query | No | string | Allowed values: asc|desc |
order[trackingNumber] | query | No | string | Allowed values: asc|desc |
order[trackingStatus] | query | No | string | Allowed values: asc|desc |
order[shipmentStatus.code] | query | No | string | Allowed values: asc|desc |
order[originCarrier] | query | No | string | Allowed values: asc|desc |
order[destinationCarrier] | query | No | string | Allowed values: asc|desc |
order[createdAt] | query | No | string | Allowed values: asc|desc |
order[updatedAt] | query | No | string | Allowed values: asc|desc |
order[shippedAt] | query | No | string | Allowed values: asc|desc |
order[lastStatusUpdate] | query | No | string | Allowed values: asc|desc |
order[expectedDeliveryDate] | query | No | string | Allowed values: asc|desc |
order[originCountry] | query | No | string | Allowed values: asc|desc |
order[destinationCountry] | query | No | string | Allowed values: asc|desc |
order[originCountryIso2] | query | No | string | Allowed values: asc|desc |
order[destinationCountryIso2] | query | No | string | Allowed values: asc|desc |
order[email] | query | No | string | Allowed values: asc|desc |
order[phoneNumber] | query | No | string | Allowed values: asc|desc |
order[daysInTransit] | query | No | string | Allowed values: asc|desc |
order[reviewTotalScore] | query | No | string | Allowed values: asc|desc |
order[address.addressLine1] | query | No | string | Allowed values: asc|desc |
order[address.addressLine2] | query | No | string | Allowed values: asc|desc |
order[address.city] | query | No | string | Allowed values: asc|desc |
order[address.company] | query | No | string | Allowed values: asc|desc |
order[address.countryIso2] | query | No | string | Allowed values: asc|desc |
order[address.firstName] | query | No | string | Allowed values: asc|desc |
order[address.lastName] | query | No | string | Allowed values: asc|desc |
order[address.postcode] | query | No | string | Allowed values: asc|desc |
order[address.state] | query | No | string | Allowed values: asc|desc |
order[daysInIdle] | query | No | string | Allowed values: asc|desc |
order[orderNumbers] | query | No | string | Allowed values: asc|desc |
orderNumbers | query | No | string | |
orderNumbers[] | query | No | array | Array of Strings. |
createdAt[before] | query | No | string | |
createdAt[strictly_before] | query | No | string | |
createdAt[after] | query | No | string | |
createdAt[strictly_after] | query | No | string | |
updatedAt[before] | query | No | string | |
updatedAt[strictly_before] | query | No | string | |
updatedAt[after] | query | No | string | |
updatedAt[strictly_after] | query | No | string | |
shippedAt[before] | query | No | string | |
shippedAt[strictly_before] | query | No | string | |
shippedAt[after] | query | No | string | |
shippedAt[strictly_after] | query | No | string | |
lastStatusUpdate[before] | query | No | string | |
lastStatusUpdate[strictly_before] | query | No | string | |
lastStatusUpdate[after] | query | No | string | |
lastStatusUpdate[strictly_after] | query | No | string | |
expectedDeliveryDate[before] | query | No | string | |
expectedDeliveryDate[strictly_before] | query | No | string | |
expectedDeliveryDate[after] | query | No | string | |
expectedDeliveryDate[strictly_after] | query | No | string | |
id | query | No | string | |
id[] | query | No | array | Array of Strings. |
trackingNumber | query | No | string | |
trackingStatus | query | No | string | |
trackingStatus[] | query | No | array | Array of Strings. |
shipmentStatus.code | query | No | string | |
shipmentStatus.code[] | query | No | array | Array of Strings. |
originCarrier | query | No | string | |
originCarrier[] | query | No | array | Array of Strings. |
destinationCarrier | query | No | string | |
destinationCarrier[] | query | No | array | Array of Strings. |
originCountry | query | No | string | |
originCountryIso2 | query | No | string | |
originCountryIso2[] | query | No | array | Array of Strings. |
destinationCountry | query | No | string | |
destinationCountryIso2 | query | No | string | |
destinationCountryIso2[] | query | No | array | Array of Strings. |
query | No | string | ||
phoneNumber | query | No | string | |
address.addressLine1 | query | No | string | |
address.addressLine2 | query | No | string | |
address.city | query | No | string | |
address.company | query | No | string | |
address.countryIso2 | query | No | string | |
address.countryIso2[] | query | No | array | Array of Strings. |
address.firstName | query | No | string | |
address.lastName | query | No | string | |
address.postcode | query | No | string | |
address.state | query | No | string | |
daysInTransit | query | No | integer | |
daysInTransit[] | query | No | array | Array of Integers. |
daysInIdle | query | No | integer | |
daysInIdle[] | query | No | array | Array of Integers. |
daysInTransit[between] | query | No | string | |
daysInTransit[gt] | query | No | string | |
daysInTransit[gte] | query | No | string | |
daysInTransit[lt] | query | No | string | |
daysInTransit[lte] | query | No | string | |
reviewTotalScore[between] | query | No | string | |
reviewTotalScore[gt] | query | No | string | |
reviewTotalScore[gte] | query | No | string | |
reviewTotalScore[lt] | query | No | string | |
reviewTotalScore[lte] | query | No | string | |
daysInIdle[between] | query | No | string | |
daysInIdle[gt] | query | No | string | |
daysInIdle[gte] | query | No | string | |
daysInIdle[lt] | query | No | string | |
daysInIdle[lte] | query | No | string | |
empty[orderNumbers] | query | No | boolean | |
empty[trackingNumber] | query | No | boolean | |
empty[email] | query | No | boolean | |
empty[phoneNumber] | query | No | boolean | |
empty[address.addressLine1] | query | No | boolean | |
empty[address.addressLine2] | query | No | boolean | |
empty[address.city] | query | No | boolean | |
empty[address.company] | query | No | boolean | |
empty[address.firstName] | query | No | boolean | |
empty[address.lastName] | query | No | boolean | |
empty[address.postcode] | query | No | boolean | |
empty[address.state] | query | No | boolean |
Name | In | Is Required | Type | Description |
---|---|---|---|---|
id | path | Yes | string | Workspace identifier |
page | query | No | integer | The collection page number The default value: 1 |
itemsPerPage | query | No | integer | The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500 |
Name | In | Is Required | Type | Description |
---|---|---|---|---|
id | path | Yes | string | Workspace identifier |
page | query | No | integer | The collection page number The default value: 1 |
itemsPerPage | query | No | integer | The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500 |
id | query | No | string | |
id[] | query | No | array | Array of Strings. |
event | query | No | string | |
event[] | query | No | array | Array of Strings. |
createdAt[before] | query | No | string | |
createdAt[strictly_before] | query | No | string | |
createdAt[after] | query | No | string | |
createdAt[strictly_after] | query | No | string | |
lastEmailSentAt[before] | query | No | string | |
lastEmailSentAt[strictly_before] | query | No | string | |
lastEmailSentAt[after] | query | No | string | |
lastEmailSentAt[strictly_after] | query | No | string |
Name | In | Is Required | Type | Description |
---|---|---|---|---|
id | path | Yes | string | Team identifier |
workspaces | path | Yes | string | Workspace identifier |
page | query | No | integer | The collection page number The default value: 1 |
itemsPerPage | query | No | integer | The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500 |
entity | query | No | string | |
entity[] | query | No | array | Array of Strings. |
entityId | query | No | string | |
entityId[] | query | No | array | Array of Strings. |
order[createdAt] | query | No | string | Allowed values: asc|desc |
Name | In | Is Required | Type | Description |
---|---|---|---|---|
id | path | Yes | string | Team identifier |
workspaces | path | Yes | string | Workspace identifier |
page | query | No | integer | The collection page number The default value: 1 |
itemsPerPage | query | No | integer | The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500 |
order[id] | query | No | string | Allowed values: asc|desc |
order[orderNumber] | query | No | string | Allowed values: asc|desc |
order[email] | query | No | string | Allowed values: asc|desc |
order[phoneNumber] | query | No | string | Allowed values: asc|desc |
order[orderStatus.code] | query | No | string | Allowed values: asc|desc |
order[subtotal] | query | No | string | Allowed values: asc|desc |
order[total] | query | No | string | Allowed values: asc|desc |
order[createdAt] | query | No | string | Allowed values: asc|desc |
order[updatedAt] | query | No | string | Allowed values: asc|desc |
order[shippingAddress.addressLine1] | query | No | string | Allowed values: asc|desc |
order[shippingAddress.addressLine2] | query | No | string | Allowed values: asc|desc |
order[shippingAddress.city] | query | No | string | Allowed values: asc|desc |
order[shippingAddress.company] | query | No | string | Allowed values: asc|desc |
order[shippingAddress.countryIso2] | query | No | string | Allowed values: asc|desc |
order[shippingAddress.firstName] | query | No | string | Allowed values: asc|desc |
order[shippingAddress.lastName] | query | No | string | Allowed values: asc|desc |
order[shippingAddress.postcode] | query | No | string | Allowed values: asc|desc |
order[shippingAddress.state] | query | No | string | Allowed values: asc|desc |
order[billingAddress.addressLine1] | query | No | string | Allowed values: asc|desc |
order[billingAddress.addressLine2] | query | No | string | Allowed values: asc|desc |
order[billingAddress.city] | query | No | string | Allowed values: asc|desc |
order[billingAddress.company] | query | No | string | Allowed values: asc|desc |
order[billingAddress.countryIso2] | query | No | string | Allowed values: asc|desc |
order[billingAddress.firstName] | query | No | string | Allowed values: asc|desc |
order[billingAddress.lastName] | query | No | string | Allowed values: asc|desc |
order[billingAddress.postcode] | query | No | string | Allowed values: asc|desc |
order[billingAddress.state] | query | No | string | Allowed values: asc|desc |
order[fulfillmentStatus] | query | No | string | Allowed values: asc|desc |
order[shipmentsWithoutTrackingCount] | query | No | string | Allowed values: asc|desc |
createdAt[before] | query | No | string | |
createdAt[strictly_before] | query | No | string | |
createdAt[after] | query | No | string | |
createdAt[strictly_after] | query | No | string | |
updatedAt[before] | query | No | string | |
updatedAt[strictly_before] | query | No | string | |
updatedAt[after] | query | No | string | |
updatedAt[strictly_after] | query | No | string | |
id | query | No | string | |
id[] | query | No | array | Array of Strings. |
orderNumber | query | No | string | |
query | No | string | ||
phoneNumber | query | No | string | |
orderStatus.code | query | No | string | |
orderStatus.code[] | query | No | array | Array of Strings. |
orderType | query | No | string | |
orderType[] | query | No | array | Array of Strings. |
shippingAddress.addressLine1 | query | No | string | |
shippingAddress.addressLine2 | query | No | string | |
shippingAddress.city | query | No | string | |
shippingAddress.company | query | No | string | |
shippingAddress.countryIso2 | query | No | string | |
shippingAddress.countryIso2[] | query | No | array | Array of Strings. |
shippingAddress.firstName | query | No | string | |
shippingAddress.lastName | query | No | string | |
shippingAddress.postcode | query | No | string | |
shippingAddress.state | query | No | string | |
billingAddress.addressLine1 | query | No | string | |
billingAddress.addressLine2 | query | No | string | |
billingAddress.city | query | No | string | |
billingAddress.company | query | No | string | |
billingAddress.countryIso2 | query | No | string | |
billingAddress.countryIso2[] | query | No | array | Array of Strings. |
billingAddress.firstName | query | No | string | |
billingAddress.lastName | query | No | string | |
billingAddress.postcode | query | No | string | |
billingAddress.state | query | No | string | |
fulfillmentStatus | query | No | string | |
fulfillmentStatus[] | query | No | array | Array of Strings. |
currency | query | No | string | |
subtotal | query | No | string | |
subtotal[] | query | No | array | Array of Strings. |
total | query | No | string | |
total[] | query | No | array | Array of Strings. |
shipmentsWithoutTrackingCount | query | No | integer | |
shipmentsWithoutTrackingCount[] | query | No | array | Array of Integers. |
subtotal[between] | query | No | string | |
subtotal[gt] | query | No | string | |
subtotal[gte] | query | No | string | |
subtotal[lt] | query | No | string | |
subtotal[lte] | query | No | string | |
total[between] | query | No | string | |
total[gt] | query | No | string | |
total[gte] | query | No | string | |
total[lt] | query | No | string | |
total[lte] | query | No | string | |
shipmentsWithoutTrackingCount[between] | query | No | string | |
shipmentsWithoutTrackingCount[gt] | query | No | string | |
shipmentsWithoutTrackingCount[gte] | query | No | string | |
shipmentsWithoutTrackingCount[lt] | query | No | string | |
shipmentsWithoutTrackingCount[lte] | query | No | string | |
empty[orderNumber] | query | No | boolean | |
empty[currency] | query | No | boolean | |
empty[email] | query | No | boolean | |
empty[phoneNumber] | query | No | boolean | |
empty[shippingAddress.addressLine1] | query | No | boolean | |
empty[shippingAddress.addressLine2] | query | No | boolean | |
empty[shippingAddress.city] | query | No | boolean | |
empty[shippingAddress.company] | query | No | boolean | |
empty[shippingAddress.firstName] | query | No | boolean | |
empty[shippingAddress.lastName] | query | No | boolean | |
empty[shippingAddress.postcode] | query | No | boolean | |
empty[shippingAddress.state] | query | No | boolean | |
empty[billingAddress.addressLine1] | query | No | boolean | |
empty[billingAddress.addressLine2] | query | No | boolean | |
empty[billingAddress.city] | query | No | boolean | |
empty[billingAddress.company] | query | No | boolean | |
empty[billingAddress.firstName] | query | No | boolean | |
empty[billingAddress.lastName] | query | No | boolean | |
empty[billingAddress.postcode] | query | No | boolean | |
empty[billingAddress.state] | query | No | boolean | |
groups[] | query | No | array | Array of Strings. |
Name | In | Is Required | Type | Description |
---|---|---|---|---|
id | path | Yes | string | Team identifier |
workspaces | path | Yes | string | Workspace identifier |
page | query | No | integer | The collection page number The default value: 1 |
itemsPerPage | query | No | integer | The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500 |
Name | In | Is Required | Type | Description |
---|---|---|---|---|
id | path | Yes | string | Team identifier |
workspaces | path | Yes | string | Workspace identifier |
page | query | No | integer | The collection page number The default value: 1 |
itemsPerPage | query | No | integer | The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500 |
entity | query | No | string | |
code | query | No | string | |
title | query | No | string | |
order[entity] | query | No | string | Allowed values: asc|desc |
order[code] | query | No | string | Allowed values: asc|desc |
order[title] | query | No | string | Allowed values: asc|desc |
Name | In | Is Required | Type | Description |
---|---|---|---|---|
id | path | Yes | string | Team identifier |
workspaces | path | Yes | string | Workspace identifier |
page | query | No | integer | The collection page number The default value: 1 |
itemsPerPage | query | No | integer | The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500 |
type | query | No | string | |
type[] | query | No | array | Array of Strings. |
period | query | No | string | |
period[] | query | No | array | Array of Strings. |
title | query | No | string | |
order[createdAt] | query | No | string | Allowed values: asc|desc |
tag | query | No | string | |
exists[integration] | query | No | boolean | |
firstTimeSetupPassed | query | No | boolean | |
first_time_setup_required | query | No | string |
Name | In | Is Required | Type | Description |
---|---|---|---|---|
id | path | Yes | string | Team identifier |
workspaces | path | Yes | string | Workspace identifier |
page | query | No | integer | The collection page number The default value: 1 |
itemsPerPage | query | No | integer | The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500 |
order[id] | query | No | string | Allowed values: asc|desc |
order[trackingNumber] | query | No | string | Allowed values: asc|desc |
order[trackingStatus] | query | No | string | Allowed values: asc|desc |
order[shipmentStatus.code] | query | No | string | Allowed values: asc|desc |
order[originCarrier] | query | No | string | Allowed values: asc|desc |
order[destinationCarrier] | query | No | string | Allowed values: asc|desc |
order[createdAt] | query | No | string | Allowed values: asc|desc |
order[updatedAt] | query | No | string | Allowed values: asc|desc |
order[shippedAt] | query | No | string | Allowed values: asc|desc |
order[lastStatusUpdate] | query | No | string | Allowed values: asc|desc |
order[expectedDeliveryDate] | query | No | string | Allowed values: asc|desc |
order[originCountry] | query | No | string | Allowed values: asc|desc |
order[destinationCountry] | query | No | string | Allowed values: asc|desc |
order[originCountryIso2] | query | No | string | Allowed values: asc|desc |
order[destinationCountryIso2] | query | No | string | Allowed values: asc|desc |
order[email] | query | No | string | Allowed values: asc|desc |
order[phoneNumber] | query | No | string | Allowed values: asc|desc |
order[daysInTransit] | query | No | string | Allowed values: asc|desc |
order[reviewTotalScore] | query | No | string | Allowed values: asc|desc |
order[address.addressLine1] | query | No | string | Allowed values: asc|desc |
order[address.addressLine2] | query | No | string | Allowed values: asc|desc |
order[address.city] | query | No | string | Allowed values: asc|desc |
order[address.company] | query | No | string | Allowed values: asc|desc |
order[address.countryIso2] | query | No | string | Allowed values: asc|desc |
order[address.firstName] | query | No | string | Allowed values: asc|desc |
order[address.lastName] | query | No | string | Allowed values: asc|desc |
order[address.postcode] | query | No | string | Allowed values: asc|desc |
order[address.state] | query | No | string | Allowed values: asc|desc |
order[daysInIdle] | query | No | string | Allowed values: asc|desc |
order[orderNumbers] | query | No | string | Allowed values: asc|desc |
orderNumbers | query | No | string | |
orderNumbers[] | query | No | array | Array of Strings. |
createdAt[before] | query | No | string | |
createdAt[strictly_before] | query | No | string | |
createdAt[after] | query | No | string | |
createdAt[strictly_after] | query | No | string | |
updatedAt[before] | query | No | string | |
updatedAt[strictly_before] | query | No | string | |
updatedAt[after] | query | No | string | |
updatedAt[strictly_after] | query | No | string | |
shippedAt[before] | query | No | string | |
shippedAt[strictly_before] | query | No | string | |
shippedAt[after] | query | No | string | |
shippedAt[strictly_after] | query | No | string | |
lastStatusUpdate[before] | query | No | string | |
lastStatusUpdate[strictly_before] | query | No | string | |
lastStatusUpdate[after] | query | No | string | |
lastStatusUpdate[strictly_after] | query | No | string | |
expectedDeliveryDate[before] | query | No | string | |
expectedDeliveryDate[strictly_before] | query | No | string | |
expectedDeliveryDate[after] | query | No | string | |
expectedDeliveryDate[strictly_after] | query | No | string | |
id | query | No | string | |
id[] | query | No | array | Array of Strings. |
trackingNumber | query | No | string | |
trackingStatus | query | No | string | |
trackingStatus[] | query | No | array | Array of Strings. |
shipmentStatus.code | query | No | string | |
shipmentStatus.code[] | query | No | array | Array of Strings. |
originCarrier | query | No | string | |
originCarrier[] | query | No | array | Array of Strings. |
destinationCarrier | query | No | string | |
destinationCarrier[] | query | No | array | Array of Strings. |
originCountry | query | No | string | |
originCountryIso2 | query | No | string | |
originCountryIso2[] | query | No | array | Array of Strings. |
destinationCountry | query | No | string | |
destinationCountryIso2 | query | No | string | |
destinationCountryIso2[] | query | No | array | Array of Strings. |
query | No | string | ||
phoneNumber | query | No | string | |
address.addressLine1 | query | No | string | |
address.addressLine2 | query | No | string | |
address.city | query | No | string | |
address.company | query | No | string | |
address.countryIso2 | query | No | string | |
address.countryIso2[] | query | No | array | Array of Strings. |
address.firstName | query | No | string | |
address.lastName | query | No | string | |
address.postcode | query | No | string | |
address.state | query | No | string | |
daysInTransit | query | No | integer | |
daysInTransit[] | query | No | array | Array of Integers. |
daysInIdle | query | No | integer | |
daysInIdle[] | query | No | array | Array of Integers. |
daysInTransit[between] | query | No | string | |
daysInTransit[gt] | query | No | string | |
daysInTransit[gte] | query | No | string | |
daysInTransit[lt] | query | No | string | |
daysInTransit[lte] | query | No | string | |
reviewTotalScore[between] | query | No | string | |
reviewTotalScore[gt] | query | No | string | |
reviewTotalScore[gte] | query | No | string | |
reviewTotalScore[lt] | query | No | string | |
reviewTotalScore[lte] | query | No | string | |
daysInIdle[between] | query | No | string | |
daysInIdle[gt] | query | No | string | |
daysInIdle[gte] | query | No | string | |
daysInIdle[lt] | query | No | string | |
daysInIdle[lte] | query | No | string | |
empty[orderNumbers] | query | No | boolean | |
empty[trackingNumber] | query | No | boolean | |
empty[email] | query | No | boolean | |
empty[phoneNumber] | query | No | boolean | |
empty[address.addressLine1] | query | No | boolean | |
empty[address.addressLine2] | query | No | boolean | |
empty[address.city] | query | No | boolean | |
empty[address.company] | query | No | boolean | |
empty[address.firstName] | query | No | boolean | |
empty[address.lastName] | query | No | boolean | |
empty[address.postcode] | query | No | boolean | |
empty[address.state] | query | No | boolean |
Name | In | Is Required | Type | Description |
---|---|---|---|---|
id | path | Yes | string | Team identifier |
workspaces | path | Yes | string | Workspace identifier |
page | query | No | integer | The collection page number The default value: 1 |
itemsPerPage | query | No | integer | The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500 |
Name | In | Is Required | Type | Description |
---|---|---|---|---|
id | path | Yes | string | Team identifier |
workspaces | path | Yes | string | Workspace identifier |
page | query | No | integer | The collection page number The default value: 1 |
itemsPerPage | query | No | integer | The number of items per page The default value: 30 The minimal value: 0 The maximal value: 500 |
id | query | No | string | |
id[] | query | No | array | Array of Strings. |
event | query | No | string | |
event[] | query | No | array | Array of Strings. |
createdAt[before] | query | No | string | |
createdAt[strictly_before] | query | No | string | |
createdAt[after] | query | No | string | |
createdAt[strictly_after] | query | No | string | |
lastEmailSentAt[before] | query | No | string | |
lastEmailSentAt[strictly_before] | query | No | string | |
lastEmailSentAt[after] | query | No | string | |
lastEmailSentAt[strictly_after] | query | No | string |
Name | In | Is Required | Type | Description |
---|
team | Type: object Example:"team": { "name": "string|null" }
|
title | Type: string |
defaultTrackingPage | Type: object|null Example:"defaultTrackingPage": { "enabled": true, "reviewsEnabled": true, "title": "string|null", "subdomain": "string", "domain": "string|null", "sidebarField": "string|null", "trackingNumberField": "string|null", "builder": "{}", "dropshipperSettings": "{}", "customThemeId": "string|null" }
|
workflowsOrder | Type: array |
logo | Type: string|null (format: iri-reference) |
emailSettings | Type: object Example:"emailSettings": { "logo": "string|null", "signature": "string|null", "smtpCredentials": "string|null" }
|
Name | In | Is Required | Type | Description |
---|---|---|---|---|
id | path | Yes | string | Resource identifier |
title | Type: string |
defaultTrackingPage | Type: object|null Example:"defaultTrackingPage": { "enabled": true, "reviewsEnabled": true, "title": "string|null", "subdomain": "string", "domain": "string|null", "sidebarField": "string|null", "trackingNumberField": "string|null", "builder": "{}", "dropshipperSettings": "{}", "customThemeId": "string|null" }
|
workflowsOrder | Type: array |
logo | Type: string|null (format: iri-reference) |
emailSettings | Type: object Example:"emailSettings": { "logo": "string|null", "signature": "string|null", "smtpCredentials": "string|null" }
|
Name | In | Is Required | Type | Description |
---|---|---|---|---|
id | path | Yes | string | Resource identifier |