Skip to main content

CustomResponse12

data object
actualInspectionDate date-time

Actual inspection date

Example: 2021-06-14T04:02:57.849000+00:00
assignedToInspector objectnullable

Inspector that the assignment is assigned to

email string

Email of the inspector that is assigned to the assignment

employeeId stringnullable

External ID of the inspector that is assigned to the assignment

Example: 123
id string

User ID of the inspector that the assignment is assigned to

Example: U111
name string

Name of the inspector that the assignment is assigned to

Example: John Doe
assignedToOrganization objectnullable

Organization that the assignment is assigned to

name string

Organization name that the assignment is assigned to

Example: Acme Corp
systemId string

Organization ID stored in the system that the assignment is assigned to

Example: 3123123
assignmentCreatedDate date-time

Assignment creation date

Example: 2021-05-25T13:58:26+00:00
assignmentId uuidrequired

Unique identifier of the assignment

Example: 1234fca6-941b-4470-bcf9-9dc7928867dc
assignmentStatus string

Assignment status

Example: NEW
assignmentUpdatedDate date-time

Assignment last updated date

Example: 2021-05-25T13:58:26+00:00
billingInformation objectnullable

Organization that is billed

address stringnullable

Address line of the organization that receives is billed

Example: 1 Park Avenue
city stringnullable

City of the organization that is billed

Example: Minnesota
contact objectnullable

Contact information of the organization

email stringnullable

Billing contact email

mobileNumber stringnullable

Billing contact mobile number

Example: 1234567890
name stringnullable

Billing contact name

Example: Will Smith
telephoneNumber stringnullable

Billing contact telephone number

Example: 1234567890
country stringnullable

Country of the organization that is billed

Example: US
name stringnullable

Name of the organization that is billed

Example: Padme Corp
postalCode stringnullable

Postal code of the organization that is billed

Example: 55402
state stringnullable

State of the organization that is billed

Example: Minnesota
bookingId string

Unique identifier of the booking

Example: 123456-c4a6-4fdb-b01f-2fe663be4460
bookingType string

Booking type e.g normal

Example: normal
caseNumber string

Case number of the booking defined by a configuration rule

Example: 3269012021-06-10ABC
clientInformation object

Information on the Brand or Retailer in the booking

address string
Example: address
city string
Example: city
contact objectnullable
contactId string
Example: contact_id
email string
mobileNumber string
Example: 1234567890
name string
Example: Contact Name
telephoneNumber string
Example: 1234567890
country string
Example: US
localOrganizationId string

Local Custom ID of the organization

Example: F323333
localOrganizationIds string[]nullable

The list of all connected Local Custom IDs of the organization

Example: ["F323333","F242146"]
name string
Example: name
organizationId string
Example: org_id
confirmedBy string

The organization which confirmed the booking

Example: Acme Corp
createdBy string

The user who created the booking

Example: John Doe
createdDate date-time

Creation date of the booking

Example: 2021-06-03T04:02:57.849000+00:00
detailOfPIPO 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_1
    brandName string

    Possible values: non-empty

    classId stringnullable
    Example: class_id_1
    color stringrequired

    Possible values: non-empty

    configuration integerrequired

    Possible values: >= 1

    departmentId stringnullable
    Example: department_id_1
    id stringnullable
    itemId stringrequired

    Possible values: non-empty

    quantity integer
    shipmentTerm stringnullable
    Example: shipment_term_1
    size stringrequired

    Possible values: non-empty

  • ]
  • ]
  • measurements object[]
  • Array [
  • caption stringrequired

    Possible values: non-empty

    isPomCritical booleannullable

    Measurement is critical or not

    Example: true
    pom 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.1
    toleranceUpper numbernullable

    Accepted upper limit between the expected measure (standard) and the actual measure

    Example: 2.1
    unit stringrequired

    Possible values: [inch, cm, mm]

  • ]
  • productCategoryId stringrequired
    Example: product_category_1
    productCategoryName 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_1
    brandName string

    Possible values: non-empty

    cartonQuantity integernullable
    casePackQuantity integernullable
    classId stringnullable
    Example: class_id_1
    color stringrequired

    Possible values: non-empty

    departmentId stringnullable
    Example: department_id_1
    id stringnullable
    itemId stringrequired

    Possible values: non-empty

    quantity integerrequired

    Possible values: >= 1

    shipmentTerm stringnullable
    Example: shipment_term_1
    size stringrequired

    Possible values: non-empty

  • ]
  • styleId stringrequired

    Possible values: non-empty

    Example: style_1
    styleName stringnullable
  • ]
  • expectedDate object

    Expected date

    inspectionDate date-timerequired
    Example: 2019-07-04T08:00:00.00Z
    shipmentDate date-timenullable
    Example: 2019-07-04T08:00:00.00Z
    factoryInformation object

    Information on the factory in the booking

    address string
    Example: address
    city string
    Example: city
    contact objectnullable
    contactId string
    Example: contact_id
    email string
    mobileNumber string
    Example: 1234567890
    name string
    Example: Contact Name
    telephoneNumber string
    Example: 1234567890
    country string
    Example: US
    localOrganizationId string

    Local Custom ID of the organization

    Example: F323333
    localOrganizationIds string[]nullable

    The list of all connected Local Custom IDs of the organization

    Example: ["F323333","F242146"]
    localPostalCode string
    Example: 82052
    localState string
    Example: Wyoming
    name string
    Example: name
    organizationId string
    Example: org_id
    fromOrganizationId string

    Organization ID where the booking is created

    Example: F001122
    fromOrganizationName string
    Example: Padme Inc
    inspectionInformation object

    Inspection Information

    typeOfInspection string
    Example: FRI
    typeOfInspectionName string
    Example: Final Random Inspection
    locationPicker 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 readiness
    freeTextAnswer string

    Free text answer for the question

    Example: Not good but acceptable
    id stringrequired

    Unique identifier of a question

    Example: abc-123
    options object[]

    List of answering options

  • Array [
  • id string

    Unique identifier of the option

    otherOptionText string

    Other option text

    Example: Acceptable
    questions object[]

    List of recursive questions from "questionnaire"

    selected boolean

    Indicate whether this option is selected or not

    Example: true
    text string

    Preset answer in text

    Example: Yes
  • ]
  • questionType stringrequired

    Question type e.g single select, multiple select

    Example: single select
    responseId string

    Unique identifier of a response

    Example: 1a2b3c
    validation 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 changes
    sampleSize integer

    Sample size of inspection

    Example: 0
    serviceType string

    Service Type of the inspection

    Example: TPR
    status string

    Booking status

    Example: NEW
    tags string[]nullable

    Labels attached to the report giving other information

    Example: ["Revised","1st re-inspection"]
    toOrganizationId string

    Organization ID which the booking is booked to

    Example: C112233
    toOrganizationName string

    Organization name which the booking is booking to

    Example: Lex Corp
    unit string

    Unit used in inspections e.g piece

    Example: piece
    updatedDate date-time

    Last updated date of the booking

    Example: 2021-06-03T04:02:57.849000+00:00
    vendorInformation object

    Information on the Vendor or Supplier in the assignment

    address string
    Example: address
    city string
    Example: city
    contact objectnullable
    contactId string
    Example: contact_id
    email string
    mobileNumber string
    Example: 1234567890
    name string
    Example: Contact Name
    telephoneNumber string
    Example: 1234567890
    country string
    Example: US
    localOrganizationId string

    Local Custom ID of the organization

    Example: F323333
    localOrganizationIds string[]nullable

    The list of all connected Local Custom IDs of the organization

    Example: ["F323333","F242146"]
    localPostalCode string
    Example: 82052
    localState string
    Example: Wyoming
    name string
    Example: name
    organizationId string
    Example: org_id
    CustomResponse12
    {
    "data": {
    "actualInspectionDate": "2021-06-14T04:02:57.849000+00:00",
    "assignedToInspector": {
    "email": "[email protected]",
    "employeeId": "123",
    "id": "U111",
    "name": "John Doe"
    },
    "assignedToOrganization": {
    "name": "Acme Corp",
    "systemId": "3123123"
    },
    "assignmentCreatedDate": "2021-05-25T13:58:26+00:00",
    "assignmentId": "1234fca6-941b-4470-bcf9-9dc7928867dc",
    "assignmentStatus": "NEW",
    "assignmentUpdatedDate": "2021-05-25T13:58:26+00:00",
    "billingInformation": {
    "address": "1 Park Avenue",
    "city": "Minnesota",
    "contact": {
    "email": "[email protected]",
    "mobileNumber": "1234567890",
    "name": "Will Smith",
    "telephoneNumber": "1234567890"
    },
    "country": "US",
    "name": "Padme Corp",
    "postalCode": "55402",
    "state": "Minnesota"
    },
    "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"
    ],
    "localPostalCode": "82052",
    "localState": "Wyoming",
    "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",
    "tags": [
    "Revised",
    "1st re-inspection"
    ],
    "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"
    ],
    "localPostalCode": "82052",
    "localState": "Wyoming",
    "name": "name",
    "organizationId": "org_id"
    }
    }
    }