AssignmentResponse

actualInspectionDatedate-time

Actual inspection date

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

assignedToInspector objectnullable

Inspector that the assignment is assigned to

emailstring

Email of the inspector that is assigned to the assignment

Example: [email protected]

employeeIdstringnullable

External ID of the inspector that is assigned to the assignment

Example: 123

idstring

User ID of the inspector that the assignment is assigned to

Example: U111

namestring

Name of the inspector that the assignment is assigned to

Example: John Doe

assignedToOrganization objectnullable

Organization that the assignment is assigned to

namestring

Organization name that the assignment is assigned to

Example: Acme Corp

systemIdstring

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

Example: 3123123

assignmentCreatedDatedate-time

Assignment creation date

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

assignmentIduuidrequired

Unique identifier of the assignment

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

assignmentStatusstring

Assignment status

Example: NEW

assignmentUpdatedDatedate-time

Assignment last updated date

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

billingInformation objectnullable

Organization that is billed

addressstringnullable

Address line of the organization that receives is billed

Example: 1 Park Avenue

citystringnullable

City of the organization that is billed

Example: Minnesota

contact objectnullable

Contact information of the organization

emailstringnullable

Billing contact email

Example: [email protected]

mobileNumberstringnullable

Billing contact mobile number

Example: 1234567890

namestringnullable

Billing contact name

Example: Will Smith

telephoneNumberstringnullable

Billing contact telephone number

Example: 1234567890

countrystringnullable

Country of the organization that is billed

Example: US

namestringnullable

Name of the organization that is billed

Example: Padme Corp

postalCodestringnullable

Postal code of the organization that is billed

Example: 55402

statestringnullable

State of the organization that is billed

Example: Minnesota

bookingIdstring

Unique identifier of the booking

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

bookingTypestring

Booking type e.g normal

Example: normal

caseNumberstring

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

addressstring

Example: address

citystring

Example: city

contact objectnullable

contactIdstring

Example: contact_id

emailstring

Example: [email protected]

mobileNumberstring

Example: 1234567890

namestring

Example: Contact Name

telephoneNumberstring

Example: 1234567890

countrystring

Example: US

localOrganizationIdstring

Local Custom ID of the organization

Example: F323333

localOrganizationIdsstring[]nullable

The list of all connected Local Custom IDs of the organization

Example: ["F323333","F242146"]

namestring

Example: name

organizationIdstring

Example: org_id

confirmedBystring

The organization which confirmed the booking

Example: Acme Corp

createdBystring

The user who created the booking

Example: John Doe

createdDatedate-time

Creation date of the booking

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

detailOfPIPO object

Details of PIPO

pipoInformation object

opoNumberstring

poNumberstring

poTypesstring[]

productLineIdstring

productLineNamestring

styles object[]

Array [

assortments object[]nullable

Array [

assortmentIdstringrequired

Possible values: non-empty

availableCartonQuantityintegernullable

cartonQuantityintegerrequired

items object[]required

Possible values: >= 1

Array [

availableQuantityintegernullable

brandIdstringnullable

Precondition: must be configured in your Inspectorio's account.

Example: brand_1

brandNamestring

Possible values: non-empty

classIdstringnullable

Example: class_id_1

colorstringrequired

Possible values: non-empty

configurationintegerrequired

Possible values: >= 1

departmentIdstringnullable

Example: department_id_1

idstringnullable

itemIdstringrequired

Possible values: non-empty

quantityinteger

shipmentTermstringnullable

Example: shipment_term_1

sizestringrequired

Possible values: non-empty

]

]

measurements object[]

Array [

captionstringrequired

Possible values: non-empty

isPomCriticalbooleannullable

Measurement is critical or not

Example: true

pomstringrequired

Possible values: non-empty

sizes object[]

Array [

measurementstringrequired

sizestringrequired

Size name

Possible values: non-empty

Example: Medium

]

tolerancestringrequired

toleranceLowernumbernullable

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

Example: 2.1

toleranceUppernumbernullable

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

Example: 2.1

unitstringrequired

Possible values: [inch, cm, mm]

]

productCategoryIdstringrequired

Example: product_category_1

productCategoryNamestring

Possible values: non-empty

solids object[]nullable

Array [

availableCartonQuantityintegernullable

availableQuantityintegernullable

brandIdstringnullable

Precondition: must be configured in your Inspectorio's account.

Example: brand_1

brandNamestring

Possible values: non-empty

cartonQuantityintegernullable

casePackQuantityintegernullable

classIdstringnullable

Example: class_id_1

colorstringrequired

Possible values: non-empty

departmentIdstringnullable

Example: department_id_1

idstringnullable

itemIdstringrequired

Possible values: non-empty

quantityintegerrequired

Possible values: >= 1

shipmentTermstringnullable

Example: shipment_term_1

sizestringrequired

Possible values: non-empty

]

styleIdstringrequired

Possible values: non-empty

Example: style_1

styleNamestringnullable

]

expectedDate object

Expected date

inspectionDatedate-timerequired

Example: 2019-07-04T08:00:00.00Z

shipmentDatedate-timenullable

Example: 2019-07-04T08:00:00.00Z

factoryInformation object

Information on the factory in the booking

addressstring

Example: address

citystring

Example: city

contact objectnullable

contactIdstring

Example: contact_id

emailstring

Example: [email protected]

mobileNumberstring

Example: 1234567890

namestring

Example: Contact Name

telephoneNumberstring

Example: 1234567890

countrystring

Example: US

localOrganizationIdstring

Local Custom ID of the organization

Example: F323333

localOrganizationIdsstring[]nullable

The list of all connected Local Custom IDs of the organization

Example: ["F323333","F242146"]

localPostalCodestring

Example: 82052

localStatestring

Example: Wyoming

namestring

Example: name

organizationIdstring

Example: org_id

fromOrganizationIdstring

Organization ID where the booking is created

Example: F001122

fromOrganizationNamestring

Example: Padme Inc

inspectionInformation object

Inspection Information

typeOfInspectionstring

Example: FRI

typeOfInspectionNamestring

Example: Final Random Inspection

locationPicker object

Location picker of where the inspection takes place

addressstring

gpsLocation object

latitudestring

longitudestring

questionnaire object

questions object[]

List of questions in the questionnaire

Array [

defaultSubQuestionsobject[]

List of recursive questions from "questionnaire"

descriptionstring

Description of the question

Example: Shipment readiness

freeTextAnswerstring

Free text answer for the question

Example: Not good but acceptable

idstringrequired

Unique identifier of a question

Example: abc-123

options object[]

List of answering options

Array [

idstring

Unique identifier of the option

otherOptionTextstring

Other option text

Example: Acceptable

questionsobject[]

List of recursive questions from "questionnaire"

selectedboolean

Indicate whether this option is selected or not

Example: true

textstring

Preset answer in text

Example: Yes

]

questionTypestringrequired

Question type e.g single select, multiple select

Example: single select

responseIdstring

Unique identifier of a response

Example: 1a2b3c

validation objectrequired

Question validation

mandatorybooleanrequired

Indicate if the question is mandatory or not

Example: true

]

remarkstring

Remark on the booking

Example: Updated to reflect changes

sampleSizeinteger

Sample size of inspection

Example: 0

serviceTypestring

Service Type of the inspection

Example: TPR

statusstring

Booking status

Example: NEW

tagsstring[]nullable

Labels attached to the report giving other information

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

toOrganizationIdstring

Organization ID which the booking is booked to

Example: C112233

toOrganizationNamestring

Organization name which the booking is booking to

Example: Lex Corp

unitstring

Unit used in inspections e.g piece

Example: piece

updatedDatedate-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

addressstring

Example: address

citystring

Example: city

contact objectnullable

contactIdstring

Example: contact_id

emailstring

Example: [email protected]

mobileNumberstring

Example: 1234567890

namestring

Example: Contact Name

telephoneNumberstring

Example: 1234567890

countrystring

Example: US

localOrganizationIdstring

Local Custom ID of the organization

Example: F323333

localOrganizationIdsstring[]nullable

The list of all connected Local Custom IDs of the organization

Example: ["F323333","F242146"]

localPostalCodestring

Example: 82052

localStatestring

Example: Wyoming

namestring

Example: name

organizationIdstring

Example: org_id

AssignmentResponse

{
  "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"
  }
}