Skip to main content

InspectionDetailResponse

data object
inspectionIduuidrequired

Inspection UUID. bookingId equals inspectionId.

caseNumberstringrequired
statusstringrequired

Aggregated inspection status (single enum string).

reasonCodeReasonCodenullable

Inspection reason code, formatted as <Action> - <reason> where Action is one of Aborted / Waived / Rejected / Split / Reset. Resolved from the configured reason option answer when present, otherwise the free-text reason. null when no reason code applies to the inspection.

Example: Aborted - Order not ready
createdDatedate-timerequired
updatedDatedate-timerequired
actualInspectionDatedate-time

Omitted unless an actual inspection date has been recorded.

expectedDate objectrequired
inspectionDatedate-timerequired

Expected inspection date (ISO-8601).

shipmentDatedate-timenullable

Expected shipment date (ISO-8601).

confirmedBystringnullable

The organization which confirmed the booking. Returns null when not confirmed.

confirmedDatedate-time

Computed from the confirm activity timestamp. Omitted when there is no confirm activity.

createdBystringrequired

The user who created the booking.

fromOrganizationIdstringrequired
fromOrganizationNamestringrequired
toOrganizationIdstringrequired
toOrganizationNamestringrequired
assignedToOrganization objectnullable

The organization the inspection is assigned to. Null/absent when there is no assignment.

idstring
namestring
localOrganizationIdsstring[]nullable
assignedToInspector objectnullable

The inspector the inspection is assigned to. Null/absent when there is no assignment.

idstring
namestring
emailstring
employeeIdstring
clientInformation objectrequired
organizationIdstring
localOrganizationIdstring
localOrganizationIdsstring[]nullable
localStatestringnullable

Province/state of the linked local organization. null unless a local organization is linked.

Example: Wyoming
localPostalCodestringnullable

Postal code of the linked local organization. null unless a local organization is linked.

Example: 82052
namestring
addressstring
citystring
countrystring

ISO alpha-2 country code.

contact objectnullable

Key contact for an organization, including its identifier. The parent contact property is null when no contact is on file.

contactIdstringnullable
Example: contact_id
namestring
Example: Contact Name
emailstring
Example: [email protected]
mobileNumberstring
Example: 1234567890
telephoneNumberstring
Example: 1234567890
vendorInformation objectrequired
organizationIdstring
localOrganizationIdstring
localOrganizationIdsstring[]nullable
localStatestringnullable

Province/state of the linked local organization. null unless a local organization is linked.

Example: Wyoming
localPostalCodestringnullable

Postal code of the linked local organization. null unless a local organization is linked.

Example: 82052
namestring
addressstring
citystring
countrystring

ISO alpha-2 country code.

contact objectnullable

Key contact for an organization, including its identifier. The parent contact property is null when no contact is on file.

contactIdstringnullable
Example: contact_id
namestring
Example: Contact Name
emailstring
Example: [email protected]
mobileNumberstring
Example: 1234567890
telephoneNumberstring
Example: 1234567890
factoryInformation objectrequired
organizationIdstring
localOrganizationIdstring
localOrganizationIdsstring[]nullable
localStatestringnullable

Province/state of the linked local organization. null unless a local organization is linked.

Example: Wyoming
localPostalCodestringnullable

Postal code of the linked local organization. null unless a local organization is linked.

Example: 82052
namestring
addressstring
citystring
countrystring

ISO alpha-2 country code.

contact objectnullable

Key contact for an organization, including its identifier. The parent contact property is null when no contact is on file.

contactIdstringnullable
Example: contact_id
namestring
Example: Contact Name
emailstring
Example: [email protected]
mobileNumberstring
Example: 1234567890
telephoneNumberstring
Example: 1234567890
locationPicker object
addressstring
gpsLocation object
latitudestring
longitudestring
inspectionFormstring

The name of the inspection form used.

workflowNamestringnullable

Workflow name. Null when no workflow is assigned.

inspectionInformation objectrequired
typeOfInspectionstring
Example: FRI
typeOfInspectionNamestring
Example: Final Random Inspection
tagsstring[]required
billingInformation object
namestring
addressstring
citystring
statestring
postalCodestring
countrystring
contact objectnullable

Key contact for an organization. When included, all contact fields are present as strings (may be empty). The parent contact property is null when no contact is on file.

namestring
Example: Contact Name
emailstring
Example: [email protected]
mobileNumberstring
Example: 1234567890
telephoneNumberstring
Example: 1234567890
detailOfPIPO object
pipoInformation object
poNumberstring
opoNumberstring
poTypesstring[]
productLineIdstring
productLineNamestring
styles object[]
  • Array [
    • styleIdstringrequired
    styleNamestringnullable
    productCategoryIdstringrequired
    productCategoryNamestring
    solids object[]nullable
  • Array [
    • idstringnullable
    itemIdstringnullable
    colorstringnullable
    sizestringnullable
    brandIdstringnullable
    brandNamestringnullable
    quantityintegernullable
    availableQuantityintegernullable
    cartonQuantityintegernullable
    availableCartonQuantityintegernullable
    casePackQuantityintegernullable
    itemPullSampleintegernullable

    AQL-derived pull sample size for this item. Only present when the request passes include_pull_sample=1 and the workmanship step is configured with an AQL table.

  • ]
    • assortmentsobject[]nullable
    measurements object[]
  • Array [
    • captionstringnullable
    pomstringnullable
    unitstringnullable
    isPomCriticalbooleannullable
    tolerancenumbernullable
    toleranceLowernumbernullable
    toleranceUppernumbernullable
    sizes object[]
  • Array [
    • sizestringnullable
    measurementstringnullable
  • ]
  • ]
  • ]
    • questionnaire object
    questions object[]
  • Array [
    • idstringrequired
    descriptionstring
    questionTypestringrequired
    optionsobject[]
    validation objectrequired
    mandatorybooleanrequired

    Maps to BookingQuestion.required (same as AMS questionnaire.questions[].validation.mandatory).

  • ]
    • InspectionDetailResponse
    {
      "data": {
        "inspectionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "caseNumber": "string",
        "status": "string",
        "reasonCode": "Aborted - Order not ready",
        "createdDate": "2024-07-29T15:51:28.071Z",
        "updatedDate": "2024-07-29T15:51:28.071Z",
        "actualInspectionDate": "2024-07-29T15:51:28.071Z",
        "expectedDate": {
          "inspectionDate": "2024-07-29T15:51:28.071Z",
          "shipmentDate": "2024-07-29T15:51:28.071Z"
        },
        "confirmedBy": "string",
        "confirmedDate": "2024-07-29T15:51:28.071Z",
        "createdBy": "string",
        "fromOrganizationId": "string",
        "fromOrganizationName": "string",
        "toOrganizationId": "string",
        "toOrganizationName": "string",
        "assignedToOrganization": {
          "id": "string",
          "name": "string",
          "localOrganizationIds": [
            "string"
          ]
        },
        "assignedToInspector": {
          "id": "string",
          "name": "string",
          "email": "string",
          "employeeId": "string"
        },
        "clientInformation": {
          "organizationId": "string",
          "localOrganizationId": "string",
          "localOrganizationIds": [
            "string"
          ],
          "localState": "Wyoming",
          "localPostalCode": "82052",
          "name": "string",
          "address": "string",
          "city": "string",
          "country": "string",
          "contact": {
            "contactId": "contact_id",
            "name": "Contact Name",
            "email": "[email protected]",
            "mobileNumber": "1234567890",
            "telephoneNumber": "1234567890"
          }
        },
        "vendorInformation": {
          "organizationId": "string",
          "localOrganizationId": "string",
          "localOrganizationIds": [
            "string"
          ],
          "localState": "Wyoming",
          "localPostalCode": "82052",
          "name": "string",
          "address": "string",
          "city": "string",
          "country": "string",
          "contact": {
            "contactId": "contact_id",
            "name": "Contact Name",
            "email": "[email protected]",
            "mobileNumber": "1234567890",
            "telephoneNumber": "1234567890"
          }
        },
        "factoryInformation": {
          "organizationId": "string",
          "localOrganizationId": "string",
          "localOrganizationIds": [
            "string"
          ],
          "localState": "Wyoming",
          "localPostalCode": "82052",
          "name": "string",
          "address": "string",
          "city": "string",
          "country": "string",
          "contact": {
            "contactId": "contact_id",
            "name": "Contact Name",
            "email": "[email protected]",
            "mobileNumber": "1234567890",
            "telephoneNumber": "1234567890"
          }
        },
        "locationPicker": {
          "address": "string",
          "gpsLocation": {
            "latitude": "string",
            "longitude": "string"
          }
        },
        "inspectionForm": "string",
        "workflowName": "string",
        "inspectionInformation": {
          "typeOfInspection": "FRI",
          "typeOfInspectionName": "Final Random Inspection"
        },
        "tags": [
          "string"
        ],
        "billingInformation": {
          "name": "string",
          "address": "string",
          "city": "string",
          "state": "string",
          "postalCode": "string",
          "country": "string",
          "contact": {
            "name": "Contact Name",
            "email": "[email protected]",
            "mobileNumber": "1234567890",
            "telephoneNumber": "1234567890"
          }
        },
        "detailOfPIPO": {
          "pipoInformation": {
            "poNumber": "string",
            "opoNumber": "string",
            "poTypes": [
              "string"
            ],
            "productLineId": "string",
            "productLineName": "string"
          },
          "styles": [
            {
              "styleId": "string",
              "styleName": "string",
              "productCategoryId": "string",
              "productCategoryName": "string",
              "solids": [
                {
                  "id": "string",
                  "itemId": "string",
                  "color": "string",
                  "size": "string",
                  "brandId": "string",
                  "brandName": "string",
                  "quantity": 0,
                  "availableQuantity": 0,
                  "cartonQuantity": 0,
                  "availableCartonQuantity": 0,
                  "casePackQuantity": 0,
                  "itemPullSample": 0
                }
              ],
              "assortments": [
                {}
              ],
              "measurements": [
                {
                  "caption": "string",
                  "pom": "string",
                  "unit": "string",
                  "isPomCritical": true,
                  "tolerance": 0,
                  "toleranceLower": 0,
                  "toleranceUpper": 0,
                  "sizes": [
                    {
                      "size": "string",
                      "measurement": "string"
                    }
                  ]
                }
              ]
            }
          ]
        },
        "questionnaire": {
          "questions": [
            {
              "id": "string",
              "description": "string",
              "questionType": "string",
              "options": [
                {}
              ],
              "validation": {
                "mandatory": true
              }
            }
          ]
        }
      }
    }