FabricInspectionCreateRequest

fabricUnitstringrequired

Unit of the fabric measurements.

Example: cm_m

factoryCustomIdstringrequired

Custom id of the factory the inspection is created for. It must be linked to a global organization.

Example: FACTORY-001

formNamestringrequired

Name of an active fabric form of the receiver. Matched case-insensitively.

Example: Fabric Form

inspectedDatestringrequired

Date the inspection was performed, in YYYY-MM-DD.

Example: 2026-01-15

inspectionTypeNamestringrequired

Name of an inspection type of the receiver. Matched case-insensitively and must be compatible with the inspection type of the workflow.

Example: Final Inspection

inspectorEmailstringrequired

Email of a user with the inspector role in your organization.

Example: [email protected]

internalIntegrationIdstringrequired

Your identifier for this inspection. It is echoed back in the response, used as the resource key of the integration log, and used to deduplicate retries: re-sending an identical payload within 12 hours returns the original result without creating a second inspection.

Possible values: <= 255 characters

Example: INT-001

materials object[]required

Inspected materials. Material ids must be unique within the request.

Possible values: >= 1

Array [

colorstringrequired

Color of the material.

Example: Blue

compositionstringrequired

Composition of the material.

Example: 100% Cotton

cuttableWidthStandardnumbernullable

Standard cuttable width of the material.

Example: 150

gsmStandardnumbernullable

Standard grams per square meter of the material.

Example: 180

materialIdstringrequired

Id of an active material shared with the receiver.

Example: MAT-001

rollLengthStandardnumbernullable

Standard roll length of the material. When omitted the actual length of the first roll is used.

Example: 100

rolls object[]required

Inspected rolls. Roll ids must be unique within the material.

Possible values: >= 1

Array [

answers object[]

Answers to the workflow questions of the fabric inspection section.

Array [

answerstring

Answer to the question. Defaults to an empty string.

Example: Good

questionstringrequired

Workflow question of the fabric inspection section. Use the CSV column-header form so that the answer is validated against the question type, for example "Additional notes (Freetext)", "Quality grade (single: A | B | C)", "Factory access granted? (Yes | No | N/A)", "Sample check (Pass | Fail)", "Inspection date (yyyy-MM-dd)" or "Defect types found (multi: Hole | Stain | Tear)". An answer whose question does not carry a recognised type suffix is stored but not validated.

Example: Additional notes (Freetext)

]

bowingintegernullable

Measured bowing percentage of the roll.

Example: 1

cuttableWidthActualnumbernullable

Measured cuttable width of the roll.

Example: 149

defects object[]

Defects found on the roll.

Array [

defectstringrequired

Defect id belonging to a defect category of the workflow.

Example: 1.1

defectCommentstring

Free-text note about the defect. Defaults to an empty string.

Example: Hole near selvedge

defectiveMeterintegerrequired

Defective length of the roll. Combined with defect it must be unique within the roll.

Possible values: >= 0

Example: 12

occurrenceDefectinteger

Number of times the defect occurs. Defaults to 1.

Possible values: >= 1

Example: 3

]

gsmActualnumbernullable

Measured grams per square meter of the roll.

Example: 182

lotIdstringrequired

Lot identifier of the roll.

Example: LOT-001

rollIdstringrequired

Roll identifier, unique within the material.

Example: ROLL-001

rollLengthActualnumberrequired

Measured length of the roll.

Example: 100.5

skewingintegernullable

Measured skewing percentage of the roll.

Example: 2

specialAttentionPointstring

Free-text remark about the roll. Defaults to an empty string.

Example: Edge damage

]

totalQuantityintegernullable

Total quantity of the material. Required to determine the sample size, so omitting it is rejected with the MISSING_REQUIRED_FIELD error code.

Example: 100

]

receiverCustomIdstringrequired

Custom id of the receiver organization, or the literal value "data_provider" to use your own organization.

Example: data_provider

workflowNamestringrequired

Name of an active workflow of the receiver. Matched case-insensitively and must contain exactly one fabric inspection section.

Example: Fabric Workflow

FabricInspectionCreateRequest

{
  "fabricUnit": "cm_m",
  "factoryCustomId": "FACTORY-001",
  "formName": "Fabric Form",
  "inspectedDate": "2026-01-15",
  "inspectionTypeName": "Final Inspection",
  "inspectorEmail": "[email protected]",
  "internalIntegrationId": "INT-001",
  "materials": [
    {
      "color": "Blue",
      "composition": "100% Cotton",
      "cuttableWidthStandard": 150,
      "gsmStandard": 180,
      "materialId": "MAT-001",
      "rollLengthStandard": 100,
      "rolls": [
        {
          "answers": [
            {
              "answer": "Good",
              "question": "Additional notes (Freetext)"
            }
          ],
          "bowing": 1,
          "cuttableWidthActual": 149,
          "defects": [
            {
              "defect": "1.1",
              "defectComment": "Hole near selvedge",
              "defectiveMeter": 12,
              "occurrenceDefect": 3
            }
          ],
          "gsmActual": 182,
          "lotId": "LOT-001",
          "rollId": "ROLL-001",
          "rollLengthActual": 100.5,
          "skewing": 2,
          "specialAttentionPoint": "Edge damage"
        }
      ],
      "totalQuantity": 100
    }
  ],
  "receiverCustomId": "data_provider",
  "workflowName": "Fabric Workflow"
}