BookingListResponse
data object[]
Bookings data
Array [
actualInspectionDate date-time
Actual inspection date
Example:
2021-06-14T04:02:57.849000+00:00bookingId string
Unique identifier of the booking
Example:
123456-c4a6-4fdb-b01f-2fe663be4460bookingType string
Booking type e.g normal
Example:
normalcaseNumber string
Case number of the booking defined by a configuration rule
Example:
3269012021-06-10ABCclientInformation object
Information on the Brand or Retailer in the booking
address string
Example:
addresscity string
Example:
citycontact objectnullable
contactId string
Example:
contact_idemail string
Example:
[email protected]mobileNumber string
Example:
1234567890name string
Example:
Contact NametelephoneNumber string
Example:
1234567890country string
Example:
USlocalOrganizationId string
Local Custom ID of the organization
Example:
F323333localOrganizationIds string[]nullable
The list of all connected Local Custom IDs of the organization
Example:
["F323333","F242146"]name string
Example:
nameorganizationId string
Example:
org_idconfirmedBy string
The organization which confirmed the booking
Example:
Acme CorpcreatedBy string
The user who created the booking
Example:
John DoecreatedDate date-time
Creation date of the booking
Example:
2021-06-03T04:02:57.849000+00:00detailOfPIPO object
Details of PIPO
pipoInformation object
opoNumber string
poNumber string
poTypes string[]
productLineId string
productLineName string
styles object[]
Array [
assortments object[]nullable
Array [
assortmentId stringrequired
Possible values: non-empty
availableCartonQuantity integernullable
cartonQuantity integerrequired
items object[]required
Possible values: >= 1
Array [
availableQuantity integernullable
brandId stringnullable
Precondition: must be configured in your Inspectorio's account.
Example:
brand_1brandName string
Possible values: non-empty
classId stringnullable
Example:
class_id_1color stringrequired
Possible values: non-empty
configuration integerrequired
Possible values: >= 1
departmentId stringnullable
Example:
department_id_1id stringnullable
itemId stringrequired
Possible values: non-empty
quantity integer
shipmentTerm stringnullable
Example:
shipment_term_1size stringrequired
Possible values: non-empty
]
]
measurements object[]
Array [
caption stringrequired
Possible values: non-empty
isPomCritical booleannullable
Measurement is critical or not
Example:
truepom stringrequired
Possible values: non-empty
sizes object[]
Array [
measurement stringrequired
size stringrequired
Size name
Possible values: non-empty
Example:
Medium]
tolerance stringrequired
toleranceLower numbernullable
Accepted lower limit between the expected measure (standard) and the actual measure
Example:
2.1toleranceUpper numbernullable
Accepted upper limit between the expected measure (standard) and the actual measure
Example:
2.1unit stringrequired
Possible values: [inch, cm, mm]
]
productCategoryId stringrequired
Example:
product_category_1productCategoryName string
Possible values: non-empty
solids object[]nullable
Array [
availableCartonQuantity integernullable
availableQuantity integernullable
brandId stringnullable
Precondition: must be configured in your Inspectorio's account.
Example:
brand_1brandName string
Possible values: non-empty
cartonQuantity integernullable
casePackQuantity integernullable
classId stringnullable
Example:
class_id_1color stringrequired
Possible values: non-empty
departmentId stringnullable
Example:
department_id_1id stringnullable
itemId stringrequired
Possible values: non-empty
quantity integerrequired
Possible values: >= 1
shipmentTerm stringnullable
Example:
shipment_term_1size stringrequired
Possible values: non-empty
]
styleId stringrequired
Possible values: non-empty
Example:
style_1styleName stringnullable
]
expectedDate object
Expected date
inspectionDate date-timerequired
Example:
2019-07-04T08:00:00.00ZshipmentDate date-timenullable
Example:
2019-07-04T08:00:00.00ZfactoryInformation object
Information on the factory in the booking
address string
Example:
addresscity string
Example:
citycontact objectnullable
contactId string
Example:
contact_idemail string
Example:
[email protected]mobileNumber string
Example:
1234567890name string
Example:
Contact NametelephoneNumber string
Example:
1234567890country string
Example:
USlocalOrganizationId string
Local Custom ID of the organization
Example:
F323333localOrganizationIds string[]nullable
The list of all connected Local Custom IDs of the organization
Example:
["F323333","F242146"]name string
Example:
nameorganizationId string
Example:
org_idfromOrganizationId string
Organization ID where the booking is created
Example:
F001122fromOrganizationName string
Example:
Padme IncinspectionInformation object
Inspection Information
typeOfInspection string
Example:
FRItypeOfInspectionName string
Example:
Final Random InspectionlocationPicker object
Location picker of where the inspection takes place
address string
gpsLocation object
latitude string
longitude string
questionnaire object
questions object[]
List of questions in the questionnaire
Array [
defaultSubQuestions object[]
List of recursive questions from "questionnaire"
description string
Description of the question
Example:
Shipment readinessfreeTextAnswer string
Free text answer for the question
Example:
Not good but acceptableid stringrequired
Unique identifier of a question
Example:
abc-123options object[]
List of answering options
Array [
id string
Unique identifier of the option
otherOptionText string
Other option text
Example:
Acceptablequestions object[]
List of recursive questions from "questionnaire"
selected boolean
Indicate whether this option is selected or not
Example:
truetext string
Preset answer in text
Example:
Yes]
questionType stringrequired
Question type e.g single select, multiple select
Example:
single selectresponseId string
Unique identifier of a response
Example:
1a2b3cvalidation objectrequired
Question validation
mandatory booleanrequired
Indicate if the question is mandatory or not
Example:
true]
remark string
Remark on the booking
Example:
Updated to reflect changessampleSize integer
Sample size of inspection
Example:
0serviceType string
Service Type of the inspection
Example:
TPRstatus string
Booking status
Example:
NEWtoOrganizationId string
Organization ID which the booking is booked to
Example:
C112233toOrganizationName string
Organization name which the booking is booking to
Example:
Lex Corpunit string
Unit used in inspections e.g piece
Example:
pieceupdatedDate date-time
Last updated date of the booking
Example:
2021-06-03T04:02:57.849000+00:00vendorInformation object
Information on the Vendor or Supplier in the booking
address string
Example:
addresscity string
Example:
citycontact objectnullable
contactId string
Example:
contact_idemail string
Example:
[email protected]mobileNumber string
Example:
1234567890name string
Example:
Contact NametelephoneNumber string
Example:
1234567890country string
Example:
USlocalOrganizationId string
Local Custom ID of the organization
Example:
F323333localOrganizationIds string[]nullable
The list of all connected Local Custom IDs of the organization
Example:
["F323333","F242146"]name string
Example:
nameorganizationId string
Example:
org_id]
limit integerrequired
Possible values: >= 1 and <= 100
offset integerrequired
total integerrequired
BookingListResponse
{
"data": [
{
"actualInspectionDate": "2021-06-14T04:02:57.849000+00:00",
"bookingId": "123456-c4a6-4fdb-b01f-2fe663be4460",
"bookingType": "normal",
"caseNumber": "3269012021-06-10ABC",
"clientInformation": {
"address": "address",
"city": "city",
"contact": {
"contactId": "contact_id",
"email": "[email protected]",
"mobileNumber": "1234567890",
"name": "Contact Name",
"telephoneNumber": "1234567890"
},
"country": "US",
"localOrganizationId": "F323333",
"localOrganizationIds": [
"F323333",
"F242146"
],
"name": "name",
"organizationId": "org_id"
},
"confirmedBy": "Acme Corp",
"createdBy": "John Doe",
"createdDate": "2021-06-03T04:02:57.849000+00:00",
"detailOfPIPO": {
"pipoInformation": {
"opoNumber": "string",
"poNumber": "string",
"poTypes": [
"string"
],
"productLineId": "string",
"productLineName": "string"
},
"styles": [
{
"assortments": [
{
"assortmentId": "string",
"availableCartonQuantity": 0,
"cartonQuantity": 0,
"items": [
{
"availableQuantity": 0,
"brandId": "brand_1",
"brandName": "string",
"classId": "class_id_1",
"color": "string",
"configuration": 0,
"departmentId": "department_id_1",
"id": "string",
"itemId": "string",
"quantity": 0,
"shipmentTerm": "shipment_term_1",
"size": "string"
}
]
}
],
"measurements": [
{
"caption": "string",
"isPomCritical": "true",
"pom": "string",
"sizes": [
{
"measurement": "string",
"size": "Medium"
}
],
"tolerance": "string",
"toleranceLower": 2.1,
"toleranceUpper": 2.1,
"unit": "inch"
}
],
"productCategoryId": "product_category_1",
"productCategoryName": "string",
"solids": [
{
"availableCartonQuantity": 0,
"availableQuantity": 0,
"brandId": "brand_1",
"brandName": "string",
"cartonQuantity": 0,
"casePackQuantity": 0,
"classId": "class_id_1",
"color": "string",
"departmentId": "department_id_1",
"id": "string",
"itemId": "string",
"quantity": 0,
"shipmentTerm": "shipment_term_1",
"size": "string"
}
],
"styleId": "style_1",
"styleName": "string"
}
]
},
"expectedDate": {
"inspectionDate": "2019-07-04T08:00:00.00Z",
"shipmentDate": "2019-07-04T08:00:00.00Z"
},
"factoryInformation": {
"address": "address",
"city": "city",
"contact": {
"contactId": "contact_id",
"email": "[email protected]",
"mobileNumber": "1234567890",
"name": "Contact Name",
"telephoneNumber": "1234567890"
},
"country": "US",
"localOrganizationId": "F323333",
"localOrganizationIds": [
"F323333",
"F242146"
],
"name": "name",
"organizationId": "org_id"
},
"fromOrganizationId": "F001122",
"fromOrganizationName": "Padme Inc",
"inspectionInformation": {
"typeOfInspection": "FRI",
"typeOfInspectionName": "Final Random Inspection"
},
"locationPicker": {
"address": "string",
"gpsLocation": {
"latitude": "string",
"longitude": "string"
}
},
"questionnaire": {
"questions": [
{
"defaultSubQuestions": [],
"description": "Q1",
"freeTextAnswer": null,
"id": "fe_Bkycc4TIX",
"options": [
{
"id": "yes",
"questions": [
{
"defaultSubQuestions": [],
"description": "Q1-1",
"freeTextAnswer": null,
"id": "fe_ryT8oEpIQ",
"options": [
{
"id": "yes",
"questions": [],
"selected": false,
"text": "Yes"
},
{
"id": "no",
"questions": [],
"selected": false,
"text": "No"
},
{
"id": "na",
"questions": [],
"selected": false,
"text": "N/A"
}
],
"questionType": "yes_no",
"responseId": null,
"validation": {
"mandatory": true
}
},
{
"defaultSubQuestions": [],
"description": "Q1-2",
"freeTextAnswer": null,
"id": "fe_ry-DjNTU7",
"options": [
{
"id": "SklfiNaUQ",
"questions": [],
"selected": false,
"text": "M1"
},
{
"id": "S1EMoNaI7",
"questions": [],
"selected": false,
"text": "M2"
},
{
"id": "HySHj3mDX",
"questions": [],
"selected": false,
"text": "M3"
},
{
"id": "other",
"otherOptionText": null,
"questions": [],
"selected": false,
"text": "Other"
}
],
"questionType": "multi_select",
"responseId": "Sy8zjNaI7",
"validation": {
"mandatory": true
}
}
],
"selected": false,
"text": "Yes"
},
{
"id": "no",
"questions": [],
"selected": true,
"text": "No"
},
{
"id": "na",
"questions": [],
"selected": false,
"text": "N/A"
}
],
"questionType": "yes_no",
"responseId": null,
"validation": {
"mandatory": true
}
},
{
"defaultSubQuestions": [
{
"defaultSubQuestions": [],
"description": "Q2-1",
"freeTextAnswer": null,
"id": "fe_SySvsVTLm",
"options": [
{
"id": "rJFMs4T8Q",
"questions": [],
"selected": false,
"text": "S1"
},
{
"id": "Sy3Mj4TIm",
"questions": [],
"selected": false,
"text": "S2"
},
{
"id": "HkSDnNaLX",
"questions": [],
"selected": false,
"text": "S3"
},
{
"id": "other",
"otherOptionText": "Hello",
"questions": [],
"selected": true,
"text": "Other"
}
],
"questionType": "single_select",
"responseId": "ryCGs4TU7",
"validation": {
"mandatory": true
}
},
{
"defaultSubQuestions": [],
"description": "Q2-2",
"freeTextAnswer": null,
"id": "fe_Syw6NDpPX",
"options": [
{
"id": "yes",
"questions": [],
"selected": false,
"text": "Yes"
},
{
"id": "no",
"questions": [],
"selected": false,
"text": "No"
},
{
"id": "na",
"questions": [],
"selected": false,
"text": "N/A"
},
{
"id": "other",
"otherOptionText": "Hello again",
"questions": [],
"selected": true,
"text": "Other"
}
],
"questionType": "yes_no",
"responseId": null,
"validation": {
"mandatory": true
}
},
{
"defaultSubQuestions": [],
"description": "Q2-3",
"freeTextAnswer": null,
"id": "fe_SJs6Ew6wm",
"options": [
{
"id": "SklfiNaUQ",
"questions": [],
"selected": false,
"text": "M1"
},
{
"id": "S1EMoNaI7",
"questions": [],
"selected": false,
"text": "M2"
},
{
"id": "HySHj3mDX",
"questions": [],
"selected": true,
"text": "M3"
},
{
"id": "other",
"otherOptionText": "free text",
"questions": [],
"selected": true,
"text": "Other"
}
],
"questionType": "multi_select",
"responseId": "Sy8zjNaI7",
"validation": {
"mandatory": true
}
}
],
"description": "Q2",
"freeTextAnswer": "free text",
"id": "fe_ByBZiNTI7",
"options": [],
"questionType": "free_text",
"responseId": null,
"validation": {
"mandatory": true
}
}
]
},
"remark": "Updated to reflect changes",
"sampleSize": 0,
"serviceType": "TPR",
"status": "NEW",
"toOrganizationId": "C112233",
"toOrganizationName": "Lex Corp",
"unit": "piece",
"updatedDate": "2021-06-03T04:02:57.849000+00:00",
"vendorInformation": {
"address": "address",
"city": "city",
"contact": {
"contactId": "contact_id",
"email": "[email protected]",
"mobileNumber": "1234567890",
"name": "Contact Name",
"telephoneNumber": "1234567890"
},
"country": "US",
"localOrganizationId": "F323333",
"localOrganizationIds": [
"F323333",
"F242146"
],
"name": "name",
"organizationId": "org_id"
}
}
],
"limit": 0,
"offset": 0,
"total": 0
}