Skip to main content

InspectionDetail

inspectionIdstring<uuid>required

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
createdDatestring<date-time>required
updatedDatestring<date-time>required
actualInspectionDatestring<date-time>

Omitted unless an actual inspection date has been recorded.

expectedDate objectrequired
inspectionDatestring<date-time>required

Expected inspection date (ISO-8601).

shipmentDatestring<date-time>nullable

Expected shipment date (ISO-8601).

confirmedBystringnullable

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

confirmedDatestring<date-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
    toleranceTypestringnullable

    Tolerance mode of the POM. Null means absolute.

    Possible values: [percentage, absolute]

    chartTypestringnullable

    Name of the measurement chart type the POM is tagged to (e.g. "Body Chart"). Null when the POM has no chart type.

    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).

  • ]
    • cqps object[]

    Critical Quality Points (CQPs) recorded on the inspection. Which inspection types carry CQPs depends on the CQP form configuration. Present only when the request passes include_cqps=1.

    • Flat list across all inspected products; each item carries its product.
    • Ordered by product customId, then capture order.
    • [] when the inspection has no CQPs.
  • Array [
    • statusstringrequired

    reviewed once the CQP was marked as reviewed during conduction.

    Possible values: [pending, reviewed]

    product objectrequired

    The inspected style or item the CQP belongs to, identified by entityType and customId.

    entityTypestringnullable

    pdt (style) or itm (item).

    customIdstringnullable
    Example: STY-2026-0417
    namestringnullable
    Example: Blue Hoodie
    namestringnullable
    Example: Needle control
    descriptionstringnullable
    Example: Confirm needle-control procedure.
    cqpTypestringnullable

    CQP type (the requirement calls it severity). Known values: safety, functional, regulation.

    Example: safety
    mitigations object[]nullable
  • Array [
    • controlLayerTypestringnullable

    product_spec, material, production_process.

    productionStepstringnullable

    material_preparation, cutting, forming_molding, printing_dyeing, sewing, assembly, surface_finishing, washing, finishing, labeling, packing, other.

    specificationstringnullable
    productionControlCheckstringnullable
    qualityControlCheckstringnullable
    property name*any

    As stored. Known keys listed.

  • ]
    • verifications object[]nullable
  • Array [
    • stageTypestringnullable

    pre_production, during_production, post_production.

    methodTypestringnullable

    certified_lab_test, process_verification_checklist, inspection.

    inspectionTypesstring[]nullable
    acceptanceCriteriastringnullable
    assignedTostringnullable

    third_party, brand_retailer, supplier_factory.

    property name*any

    As stored. Known keys listed.

  • ]
    • commentstringnullable

    Self-assessment note by the supplier / factory.

    attachments object[]nullable

    Attachments of the self-assessment note.

  • Array [
    • fileUrlstring
    fileNamestringnullable
    fileContentTypestringnullable
    property name*any

    A file reference, returned exactly as stored by web / mobile. The server does not sign or proxy the file. Known keys listed.

  • ]
    • reviewNote objectnullable

    Review note recorded by the reviewer during conduction. As stored.

    commentstringnullable
    attachments object[]nullable
  • Array [
    • fileUrlstring
    fileNamestringnullable
    fileContentTypestringnullable
    property name*any

    A file reference, returned exactly as stored by web / mobile. The server does not sign or proxy the file. Known keys listed.

  • ]
    • property name*anynullable

    Review note recorded by the reviewer during conduction. As stored.

  • ]
    • InspectionDetail
    {
      "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,
                "toleranceType": "percentage",
                "chartType": "string",
                "sizes": [
                  {
                    "size": "string",
                    "measurement": "string"
                  }
                ]
              }
            ]
          }
        ]
      },
      "questionnaire": {
        "questions": [
          {
            "id": "string",
            "description": "string",
            "questionType": "string",
            "options": [
              {}
            ],
            "validation": {
              "mandatory": true
            }
          }
        ]
      },
      "cqps": [
        {
          "status": "pending",
          "product": {
            "entityType": "string",
            "customId": "STY-2026-0417",
            "name": "Blue Hoodie"
          },
          "name": "Needle control",
          "description": "Confirm needle-control procedure.",
          "cqpType": "safety",
          "mitigations": [
            {
              "controlLayerType": "string",
              "productionStep": "string",
              "specification": "string",
              "productionControlCheck": "string",
              "qualityControlCheck": "string"
            }
          ],
          "verifications": [
            {
              "stageType": "string",
              "methodType": "string",
              "inspectionTypes": [
                "string"
              ],
              "acceptanceCriteria": "string",
              "assignedTo": "string"
            }
          ],
          "comment": "string",
          "attachments": [
            {
              "fileUrl": "string",
              "fileName": "string",
              "fileContentType": "string"
            }
          ],
          "reviewNote": {
            "comment": "string",
            "attachments": [
              {
                "fileUrl": "string",
                "fileName": "string",
                "fileContentType": "string"
              }
            ]
          }
        }
      ]
    }