# Models ## The BoardingTag object ```json {"openapi":"3.1.1","info":{"title":"Equipment Order","version":"2.0"},"components":{"schemas":{"BoardingTag":{"type":"object","properties":{"group":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}},"title":"BoardingTag"}}}} ``` ## The Calendar object ```json {"openapi":"3.1.1","info":{"title":"Equipment Order","version":"2.0"},"components":{"schemas":{"Calendar":{"type":"object","properties":{"calendarType":{"type":"string","description":"Type of calendar used."},"fieldsComputed":{"type":"integer","format":"int32","description":"Number of computed calendar fields."},"fieldsNormalized":{"type":"integer","format":"int32","description":"Number of normalized calendar fields."},"firstDayOfWeek":{"type":"integer","format":"int32","description":"The first day of the week (1 = Sunday, 2 = Monday, etc.)."},"lenient":{"type":"boolean","description":"Indicates if the calendar allows lenient parsing."},"minimalDaysInFirstWeek":{"type":"integer","format":"int32","description":"Minimal days required in the first week of the year."},"time":{"type":"string","format":"date-time","description":"The ISO 8601 timestamp of order creation."},"timeInMillis":{"type":"integer","format":"int64","description":"Timestamp in milliseconds."},"timeZone":{"$ref":"#/components/schemas/TimeZone"},"weekCountData":{"$ref":"#/components/schemas/Locale"},"weekDateSupported":{"type":"boolean","description":"Indicates whether the week date system is supported for this calendar."},"weekYear":{"type":"integer","format":"int32","description":"The week-based year of the date."},"weeksInWeekYear":{"type":"integer","format":"int32","description":"Total number of weeks in the week-based year."},"zoneShared":{"type":"boolean","description":"Indicates whether the time zone is shared across calendars."}},"title":"Calendar"},"TimeZone":{"type":"object","description":"Time zone information of the order creation.","properties":{"displayName":{"type":"string","description":"Display name of the time zone."},"dstsavings":{"type":"integer","format":"int32","description":"Daylight saving time offset."},"id":{"type":"string","description":"Time zone ID."},"rawOffset":{"type":"integer","format":"int32","description":"Raw offset from UTC in milliseconds."}},"title":"TimeZone"},"Locale":{"type":"object","description":"Locale and week information for calendar calculations.","properties":{"country":{"type":"string","description":"The country code used for week calculations."},"displayCountry":{"type":"string","description":"Display name of the country."},"displayLanguage":{"type":"string","description":"Display name of the language."},"displayName":{"type":"string","description":"Localized display name for the calendar/locale."},"displayScript":{"type":"string","description":"Display name of the script used."},"displayVariant":{"type":"string","description":"Display variant of the locale."},"extensionKeys":{"type":"array","description":"Extension keys for additional locale information.","items":{"$ref":"#/components/schemas/Character"}},"iso3Country":{"type":"string","description":"ISO 3166-1 alpha-3 country code."},"iso3Language":{"type":"string","description":"ISO 639-2 language code."},"language":{"type":"string","description":"Language code for the locale."},"script":{"type":"string","description":"Script code for the locale."},"unicodeLocaleAttributes":{"type":"array","description":"Unicode locale attributes for the calendar.","items":{"type":"string"}},"unicodeLocaleKeys":{"type":"array","description":"Unicode locale keys for the calendar.","items":{"type":"string"}},"variant":{"type":"string","description":"Locale variant information."}},"title":"Locale"},"Character":{"type":"object","title":"Character"}}}} ``` ## The Character object ```json {"openapi":"3.1.1","info":{"title":"Equipment Order","version":"2.0"},"components":{"schemas":{"Character":{"type":"object","title":"Character"}}}} ``` ## The EquipmentOrderCollection object ```json {"openapi":"3.1.1","info":{"title":"Equipment Order","version":"2.0"},"components":{"schemas":{"EquipmentOrderCollection":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/Metadata"},"orders":{"type":"array","items":{"$ref":"#/components/schemas/EquipmentOrderForm"}}},"title":"EquipmentOrderCollection"},"Metadata":{"type":"object","properties":{"exchangeId":{"type":"string","description":"Unique correlation ID for the order request."},"timestamp":{"type":"string","description":"Timestamp of when the order request was generated. Format: yyyy-MM-dd'T'hh:mm:ss.SSS"}},"title":"Metadata"},"EquipmentOrderForm":{"type":"object","properties":{"errors":{"type":"array","description":"Contains validation errors with details about the field and message.","items":{"$ref":"#/components/schemas/ValidationError"}},"merchantNumber":{"type":"string","description":"The unique identifier of the merchant."},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Contains metadata about the order request."},"orderCreateTime":{"$ref":"#/components/schemas/Calendar"},"orderId":{"type":"string","description":"Unique identifier for the order."},"orderItems":{"type":"array","description":"List of items included in the order, such as equipment, software, or accessories.","items":{"$ref":"#/components/schemas/OrderItem"}},"orderModifyTime":{"description":"Details of when the order was last modified, including time zone, week data, and timestamp.","$ref":"#/components/schemas/Calendar"},"resubmit":{"type":"boolean","description":"Indicates if the order is a resubmission."},"status":{"type":"string","description":"Current status of the order. Possible values: Active Submitted Signed Approved AddedSalesforce BoardedTSYS BoardedQuest Shipped BackOrdered Deleted Completed OffRamp WaitingForTracking BoardedDevice","enum":["Active","Submitted","Signed","Approved","AddedSalesforce","BoardedTSYS","BoardedQuest","Shipped","BackOrdered","Deleted","Completed","OffRamp","WaitingForTracking","BoardedDevice"]},"validFrontends":{"type":"array","description":"List of supported frontends for the order.","items":{"type":"string"}}},"title":"EquipmentOrderForm"},"ValidationError":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}},"title":"ValidationError"},"Calendar":{"type":"object","properties":{"calendarType":{"type":"string","description":"Type of calendar used."},"fieldsComputed":{"type":"integer","format":"int32","description":"Number of computed calendar fields."},"fieldsNormalized":{"type":"integer","format":"int32","description":"Number of normalized calendar fields."},"firstDayOfWeek":{"type":"integer","format":"int32","description":"The first day of the week (1 = Sunday, 2 = Monday, etc.)."},"lenient":{"type":"boolean","description":"Indicates if the calendar allows lenient parsing."},"minimalDaysInFirstWeek":{"type":"integer","format":"int32","description":"Minimal days required in the first week of the year."},"time":{"type":"string","format":"date-time","description":"The ISO 8601 timestamp of order creation."},"timeInMillis":{"type":"integer","format":"int64","description":"Timestamp in milliseconds."},"timeZone":{"$ref":"#/components/schemas/TimeZone"},"weekCountData":{"$ref":"#/components/schemas/Locale"},"weekDateSupported":{"type":"boolean","description":"Indicates whether the week date system is supported for this calendar."},"weekYear":{"type":"integer","format":"int32","description":"The week-based year of the date."},"weeksInWeekYear":{"type":"integer","format":"int32","description":"Total number of weeks in the week-based year."},"zoneShared":{"type":"boolean","description":"Indicates whether the time zone is shared across calendars."}},"title":"Calendar"},"TimeZone":{"type":"object","description":"Time zone information of the order creation.","properties":{"displayName":{"type":"string","description":"Display name of the time zone."},"dstsavings":{"type":"integer","format":"int32","description":"Daylight saving time offset."},"id":{"type":"string","description":"Time zone ID."},"rawOffset":{"type":"integer","format":"int32","description":"Raw offset from UTC in milliseconds."}},"title":"TimeZone"},"Locale":{"type":"object","description":"Locale and week information for calendar calculations.","properties":{"country":{"type":"string","description":"The country code used for week calculations."},"displayCountry":{"type":"string","description":"Display name of the country."},"displayLanguage":{"type":"string","description":"Display name of the language."},"displayName":{"type":"string","description":"Localized display name for the calendar/locale."},"displayScript":{"type":"string","description":"Display name of the script used."},"displayVariant":{"type":"string","description":"Display variant of the locale."},"extensionKeys":{"type":"array","description":"Extension keys for additional locale information.","items":{"$ref":"#/components/schemas/Character"}},"iso3Country":{"type":"string","description":"ISO 3166-1 alpha-3 country code."},"iso3Language":{"type":"string","description":"ISO 639-2 language code."},"language":{"type":"string","description":"Language code for the locale."},"script":{"type":"string","description":"Script code for the locale."},"unicodeLocaleAttributes":{"type":"array","description":"Unicode locale attributes for the calendar.","items":{"type":"string"}},"unicodeLocaleKeys":{"type":"array","description":"Unicode locale keys for the calendar.","items":{"type":"string"}},"variant":{"type":"string","description":"Locale variant information."}},"title":"Locale"},"Character":{"type":"object","title":"Character"},"OrderItem":{"type":"object","description":"List of items included in the order, such as equipment, software, or accessories.","properties":{"completionDate":{"type":"string","description":"Completion date of the order item. Format: MM/dd/yyyy HH:mm a"},"errors":{"type":"array","description":"Errors related to a specific order item.","items":{"$ref":"#/components/schemas/ValidationError"}},"manufacturer":{"type":"string","description":"Name of the equipment manufacturer."},"orderItemId":{"type":"integer","format":"int32","description":"Unique identifier of the order item."},"orderItemMetadata":{"type":"array","description":"Additional metadata about the order item (API key, model, serial number, tracking, etc.).","items":{"$ref":"#/components/schemas/OrderItemMetadata"}},"productName":{"type":"string","description":"Name of the ordered product."},"productType":{"type":"string","description":"Type of the product (Example: Software, Hardware).","enum":["Software","Terminal"]},"quantity":{"type":"integer","format":"int32","description":"Number of units ordered for the product."},"survey":{"$ref":"#/components/schemas/Survey","description":"Equipment survey details linked with the order item."},"surveyValid":{"type":"boolean","description":"Indicates whether the survey data is valid."},"trackingNumber":{"type":"string","description":"Tracking number for the shipment or order item."},"validFrontends":{"type":"array","description":"List of supported frontends for the order item.","items":{"type":"string"}}},"title":"OrderItem"},"OrderItemMetadata":{"type":"object","properties":{"apiKey":{"type":"string","description":"API key associated with the order item."},"orderStatus":{"type":"string","description":"Current status of the order item."},"productManufacturer":{"type":"string","description":"Name of the manufacturer for the product."},"productModel":{"type":"string","description":"Model of the product."},"publicKey":{"type":"string","description":"Public key associated with the product or order item."},"salesforceCaseNumber":{"type":"string","description":"Salesforce case number related to the order item."},"serialNumber":{"type":"string","description":"Serial number of the product."},"storeNumber":{"type":"integer","format":"int32","description":"Store number of the product."},"tcn":{"type":"string","description":"Transaction control number related to the item."},"terminalId":{"type":"integer","format":"int32","description":"Terminal ID associated with the product or order."},"trackingNumber":{"type":"string","description":"Tracking number for shipping the product."},"vNumber":{"type":"string","description":"Version number or internal reference number for the order item."}},"title":"OrderItemMetadata"},"Survey":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/Metadata","description":"Contains metadata about the survey or order request."},"questionAnswerGroup":{"$ref":"#/components/schemas/QuestionAnswerGroup","description":"Contains the structure and data for survey questions and answers."}},"title":"Survey"},"QuestionAnswerGroup":{"type":"object","properties":{"questionAnswerSets":{"type":"object","description":"Holds sets of related questions and their possible answers.","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswerSet"}}},"questionAreas":{"type":"array","description":"Lists the survey question categories or areas being addressed.","items":{"type":"string"}}},"title":"QuestionAnswerGroup"},"QuestionAnswerSet":{"type":"object","properties":{"answers":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswer"}},"children":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswerSet"}},"conditionalOnAnswer":{"type":"integer","format":"int32"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}},"isHidden":{"type":"boolean"},"question":{"type":"string"},"required":{"type":"boolean"},"selectedAnswer":{"type":"integer","format":"int32"},"sendToMerchantApp":{"type":"boolean"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/BoardingTag"}},"type":{"type":"string"},"valid":{"type":"boolean"}},"title":"QuestionAnswerSet"},"QuestionAnswer":{"type":"object","properties":{"answer":{"type":"string"},"id":{"type":"integer","format":"int32"},"selected":{"type":"boolean"}},"title":"QuestionAnswer"},"BoardingTag":{"type":"object","properties":{"group":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}},"title":"BoardingTag"}}}} ``` ## The EquipmentOrderForm object ```json {"openapi":"3.1.1","info":{"title":"Equipment Order","version":"2.0"},"components":{"schemas":{"EquipmentOrderForm":{"type":"object","properties":{"errors":{"type":"array","description":"Contains validation errors with details about the field and message.","items":{"$ref":"#/components/schemas/ValidationError"}},"merchantNumber":{"type":"string","description":"The unique identifier of the merchant."},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Contains metadata about the order request."},"orderCreateTime":{"$ref":"#/components/schemas/Calendar"},"orderId":{"type":"string","description":"Unique identifier for the order."},"orderItems":{"type":"array","description":"List of items included in the order, such as equipment, software, or accessories.","items":{"$ref":"#/components/schemas/OrderItem"}},"orderModifyTime":{"description":"Details of when the order was last modified, including time zone, week data, and timestamp.","$ref":"#/components/schemas/Calendar"},"resubmit":{"type":"boolean","description":"Indicates if the order is a resubmission."},"status":{"type":"string","description":"Current status of the order. Possible values: Active Submitted Signed Approved AddedSalesforce BoardedTSYS BoardedQuest Shipped BackOrdered Deleted Completed OffRamp WaitingForTracking BoardedDevice","enum":["Active","Submitted","Signed","Approved","AddedSalesforce","BoardedTSYS","BoardedQuest","Shipped","BackOrdered","Deleted","Completed","OffRamp","WaitingForTracking","BoardedDevice"]},"validFrontends":{"type":"array","description":"List of supported frontends for the order.","items":{"type":"string"}}},"title":"EquipmentOrderForm"},"ValidationError":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}},"title":"ValidationError"},"Metadata":{"type":"object","properties":{"exchangeId":{"type":"string","description":"Unique correlation ID for the order request."},"timestamp":{"type":"string","description":"Timestamp of when the order request was generated. Format: yyyy-MM-dd'T'hh:mm:ss.SSS"}},"title":"Metadata"},"Calendar":{"type":"object","properties":{"calendarType":{"type":"string","description":"Type of calendar used."},"fieldsComputed":{"type":"integer","format":"int32","description":"Number of computed calendar fields."},"fieldsNormalized":{"type":"integer","format":"int32","description":"Number of normalized calendar fields."},"firstDayOfWeek":{"type":"integer","format":"int32","description":"The first day of the week (1 = Sunday, 2 = Monday, etc.)."},"lenient":{"type":"boolean","description":"Indicates if the calendar allows lenient parsing."},"minimalDaysInFirstWeek":{"type":"integer","format":"int32","description":"Minimal days required in the first week of the year."},"time":{"type":"string","format":"date-time","description":"The ISO 8601 timestamp of order creation."},"timeInMillis":{"type":"integer","format":"int64","description":"Timestamp in milliseconds."},"timeZone":{"$ref":"#/components/schemas/TimeZone"},"weekCountData":{"$ref":"#/components/schemas/Locale"},"weekDateSupported":{"type":"boolean","description":"Indicates whether the week date system is supported for this calendar."},"weekYear":{"type":"integer","format":"int32","description":"The week-based year of the date."},"weeksInWeekYear":{"type":"integer","format":"int32","description":"Total number of weeks in the week-based year."},"zoneShared":{"type":"boolean","description":"Indicates whether the time zone is shared across calendars."}},"title":"Calendar"},"TimeZone":{"type":"object","description":"Time zone information of the order creation.","properties":{"displayName":{"type":"string","description":"Display name of the time zone."},"dstsavings":{"type":"integer","format":"int32","description":"Daylight saving time offset."},"id":{"type":"string","description":"Time zone ID."},"rawOffset":{"type":"integer","format":"int32","description":"Raw offset from UTC in milliseconds."}},"title":"TimeZone"},"Locale":{"type":"object","description":"Locale and week information for calendar calculations.","properties":{"country":{"type":"string","description":"The country code used for week calculations."},"displayCountry":{"type":"string","description":"Display name of the country."},"displayLanguage":{"type":"string","description":"Display name of the language."},"displayName":{"type":"string","description":"Localized display name for the calendar/locale."},"displayScript":{"type":"string","description":"Display name of the script used."},"displayVariant":{"type":"string","description":"Display variant of the locale."},"extensionKeys":{"type":"array","description":"Extension keys for additional locale information.","items":{"$ref":"#/components/schemas/Character"}},"iso3Country":{"type":"string","description":"ISO 3166-1 alpha-3 country code."},"iso3Language":{"type":"string","description":"ISO 639-2 language code."},"language":{"type":"string","description":"Language code for the locale."},"script":{"type":"string","description":"Script code for the locale."},"unicodeLocaleAttributes":{"type":"array","description":"Unicode locale attributes for the calendar.","items":{"type":"string"}},"unicodeLocaleKeys":{"type":"array","description":"Unicode locale keys for the calendar.","items":{"type":"string"}},"variant":{"type":"string","description":"Locale variant information."}},"title":"Locale"},"Character":{"type":"object","title":"Character"},"OrderItem":{"type":"object","description":"List of items included in the order, such as equipment, software, or accessories.","properties":{"completionDate":{"type":"string","description":"Completion date of the order item. Format: MM/dd/yyyy HH:mm a"},"errors":{"type":"array","description":"Errors related to a specific order item.","items":{"$ref":"#/components/schemas/ValidationError"}},"manufacturer":{"type":"string","description":"Name of the equipment manufacturer."},"orderItemId":{"type":"integer","format":"int32","description":"Unique identifier of the order item."},"orderItemMetadata":{"type":"array","description":"Additional metadata about the order item (API key, model, serial number, tracking, etc.).","items":{"$ref":"#/components/schemas/OrderItemMetadata"}},"productName":{"type":"string","description":"Name of the ordered product."},"productType":{"type":"string","description":"Type of the product (Example: Software, Hardware).","enum":["Software","Terminal"]},"quantity":{"type":"integer","format":"int32","description":"Number of units ordered for the product."},"survey":{"$ref":"#/components/schemas/Survey","description":"Equipment survey details linked with the order item."},"surveyValid":{"type":"boolean","description":"Indicates whether the survey data is valid."},"trackingNumber":{"type":"string","description":"Tracking number for the shipment or order item."},"validFrontends":{"type":"array","description":"List of supported frontends for the order item.","items":{"type":"string"}}},"title":"OrderItem"},"OrderItemMetadata":{"type":"object","properties":{"apiKey":{"type":"string","description":"API key associated with the order item."},"orderStatus":{"type":"string","description":"Current status of the order item."},"productManufacturer":{"type":"string","description":"Name of the manufacturer for the product."},"productModel":{"type":"string","description":"Model of the product."},"publicKey":{"type":"string","description":"Public key associated with the product or order item."},"salesforceCaseNumber":{"type":"string","description":"Salesforce case number related to the order item."},"serialNumber":{"type":"string","description":"Serial number of the product."},"storeNumber":{"type":"integer","format":"int32","description":"Store number of the product."},"tcn":{"type":"string","description":"Transaction control number related to the item."},"terminalId":{"type":"integer","format":"int32","description":"Terminal ID associated with the product or order."},"trackingNumber":{"type":"string","description":"Tracking number for shipping the product."},"vNumber":{"type":"string","description":"Version number or internal reference number for the order item."}},"title":"OrderItemMetadata"},"Survey":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/Metadata","description":"Contains metadata about the survey or order request."},"questionAnswerGroup":{"$ref":"#/components/schemas/QuestionAnswerGroup","description":"Contains the structure and data for survey questions and answers."}},"title":"Survey"},"QuestionAnswerGroup":{"type":"object","properties":{"questionAnswerSets":{"type":"object","description":"Holds sets of related questions and their possible answers.","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswerSet"}}},"questionAreas":{"type":"array","description":"Lists the survey question categories or areas being addressed.","items":{"type":"string"}}},"title":"QuestionAnswerGroup"},"QuestionAnswerSet":{"type":"object","properties":{"answers":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswer"}},"children":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswerSet"}},"conditionalOnAnswer":{"type":"integer","format":"int32"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}},"isHidden":{"type":"boolean"},"question":{"type":"string"},"required":{"type":"boolean"},"selectedAnswer":{"type":"integer","format":"int32"},"sendToMerchantApp":{"type":"boolean"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/BoardingTag"}},"type":{"type":"string"},"valid":{"type":"boolean"}},"title":"QuestionAnswerSet"},"QuestionAnswer":{"type":"object","properties":{"answer":{"type":"string"},"id":{"type":"integer","format":"int32"},"selected":{"type":"boolean"}},"title":"QuestionAnswer"},"BoardingTag":{"type":"object","properties":{"group":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}},"title":"BoardingTag"}}}} ``` ## The Locale object ```json {"openapi":"3.1.1","info":{"title":"Equipment Order","version":"2.0"},"components":{"schemas":{"Locale":{"type":"object","description":"Locale and week information for calendar calculations.","properties":{"country":{"type":"string","description":"The country code used for week calculations."},"displayCountry":{"type":"string","description":"Display name of the country."},"displayLanguage":{"type":"string","description":"Display name of the language."},"displayName":{"type":"string","description":"Localized display name for the calendar/locale."},"displayScript":{"type":"string","description":"Display name of the script used."},"displayVariant":{"type":"string","description":"Display variant of the locale."},"extensionKeys":{"type":"array","description":"Extension keys for additional locale information.","items":{"$ref":"#/components/schemas/Character"}},"iso3Country":{"type":"string","description":"ISO 3166-1 alpha-3 country code."},"iso3Language":{"type":"string","description":"ISO 639-2 language code."},"language":{"type":"string","description":"Language code for the locale."},"script":{"type":"string","description":"Script code for the locale."},"unicodeLocaleAttributes":{"type":"array","description":"Unicode locale attributes for the calendar.","items":{"type":"string"}},"unicodeLocaleKeys":{"type":"array","description":"Unicode locale keys for the calendar.","items":{"type":"string"}},"variant":{"type":"string","description":"Locale variant information."}},"title":"Locale"},"Character":{"type":"object","title":"Character"}}}} ``` ## The Metadata object ```json {"openapi":"3.1.1","info":{"title":"Equipment Order","version":"2.0"},"components":{"schemas":{"Metadata":{"type":"object","properties":{"exchangeId":{"type":"string","description":"Unique correlation ID for the order request."},"timestamp":{"type":"string","description":"Timestamp of when the order request was generated. Format: yyyy-MM-dd'T'hh:mm:ss.SSS"}},"title":"Metadata"}}}} ``` ## The OrderItem object ```json {"openapi":"3.1.1","info":{"title":"Equipment Order","version":"2.0"},"components":{"schemas":{"OrderItem":{"type":"object","description":"List of items included in the order, such as equipment, software, or accessories.","properties":{"completionDate":{"type":"string","description":"Completion date of the order item. Format: MM/dd/yyyy HH:mm a"},"errors":{"type":"array","description":"Errors related to a specific order item.","items":{"$ref":"#/components/schemas/ValidationError"}},"manufacturer":{"type":"string","description":"Name of the equipment manufacturer."},"orderItemId":{"type":"integer","format":"int32","description":"Unique identifier of the order item."},"orderItemMetadata":{"type":"array","description":"Additional metadata about the order item (API key, model, serial number, tracking, etc.).","items":{"$ref":"#/components/schemas/OrderItemMetadata"}},"productName":{"type":"string","description":"Name of the ordered product."},"productType":{"type":"string","description":"Type of the product (Example: Software, Hardware).","enum":["Software","Terminal"]},"quantity":{"type":"integer","format":"int32","description":"Number of units ordered for the product."},"survey":{"$ref":"#/components/schemas/Survey","description":"Equipment survey details linked with the order item."},"surveyValid":{"type":"boolean","description":"Indicates whether the survey data is valid."},"trackingNumber":{"type":"string","description":"Tracking number for the shipment or order item."},"validFrontends":{"type":"array","description":"List of supported frontends for the order item.","items":{"type":"string"}}},"title":"OrderItem"},"ValidationError":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}},"title":"ValidationError"},"OrderItemMetadata":{"type":"object","properties":{"apiKey":{"type":"string","description":"API key associated with the order item."},"orderStatus":{"type":"string","description":"Current status of the order item."},"productManufacturer":{"type":"string","description":"Name of the manufacturer for the product."},"productModel":{"type":"string","description":"Model of the product."},"publicKey":{"type":"string","description":"Public key associated with the product or order item."},"salesforceCaseNumber":{"type":"string","description":"Salesforce case number related to the order item."},"serialNumber":{"type":"string","description":"Serial number of the product."},"storeNumber":{"type":"integer","format":"int32","description":"Store number of the product."},"tcn":{"type":"string","description":"Transaction control number related to the item."},"terminalId":{"type":"integer","format":"int32","description":"Terminal ID associated with the product or order."},"trackingNumber":{"type":"string","description":"Tracking number for shipping the product."},"vNumber":{"type":"string","description":"Version number or internal reference number for the order item."}},"title":"OrderItemMetadata"},"Survey":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/Metadata","description":"Contains metadata about the survey or order request."},"questionAnswerGroup":{"$ref":"#/components/schemas/QuestionAnswerGroup","description":"Contains the structure and data for survey questions and answers."}},"title":"Survey"},"Metadata":{"type":"object","properties":{"exchangeId":{"type":"string","description":"Unique correlation ID for the order request."},"timestamp":{"type":"string","description":"Timestamp of when the order request was generated. Format: yyyy-MM-dd'T'hh:mm:ss.SSS"}},"title":"Metadata"},"QuestionAnswerGroup":{"type":"object","properties":{"questionAnswerSets":{"type":"object","description":"Holds sets of related questions and their possible answers.","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswerSet"}}},"questionAreas":{"type":"array","description":"Lists the survey question categories or areas being addressed.","items":{"type":"string"}}},"title":"QuestionAnswerGroup"},"QuestionAnswerSet":{"type":"object","properties":{"answers":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswer"}},"children":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswerSet"}},"conditionalOnAnswer":{"type":"integer","format":"int32"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}},"isHidden":{"type":"boolean"},"question":{"type":"string"},"required":{"type":"boolean"},"selectedAnswer":{"type":"integer","format":"int32"},"sendToMerchantApp":{"type":"boolean"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/BoardingTag"}},"type":{"type":"string"},"valid":{"type":"boolean"}},"title":"QuestionAnswerSet"},"QuestionAnswer":{"type":"object","properties":{"answer":{"type":"string"},"id":{"type":"integer","format":"int32"},"selected":{"type":"boolean"}},"title":"QuestionAnswer"},"BoardingTag":{"type":"object","properties":{"group":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}},"title":"BoardingTag"}}}} ``` ## The OrderItemMetadata object ```json {"openapi":"3.1.1","info":{"title":"Equipment Order","version":"2.0"},"components":{"schemas":{"OrderItemMetadata":{"type":"object","properties":{"apiKey":{"type":"string","description":"API key associated with the order item."},"orderStatus":{"type":"string","description":"Current status of the order item."},"productManufacturer":{"type":"string","description":"Name of the manufacturer for the product."},"productModel":{"type":"string","description":"Model of the product."},"publicKey":{"type":"string","description":"Public key associated with the product or order item."},"salesforceCaseNumber":{"type":"string","description":"Salesforce case number related to the order item."},"serialNumber":{"type":"string","description":"Serial number of the product."},"storeNumber":{"type":"integer","format":"int32","description":"Store number of the product."},"tcn":{"type":"string","description":"Transaction control number related to the item."},"terminalId":{"type":"integer","format":"int32","description":"Terminal ID associated with the product or order."},"trackingNumber":{"type":"string","description":"Tracking number for shipping the product."},"vNumber":{"type":"string","description":"Version number or internal reference number for the order item."}},"title":"OrderItemMetadata"}}}} ``` ## The OrderMetadata object ```json {"openapi":"3.1.1","info":{"title":"Equipment Order","version":"2.0"},"components":{"schemas":{"OrderMetadata":{"type":"object","properties":{"orderItemId":{"type":"integer","format":"int32"},"orderItemMetadata":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemMetadata"}}},"title":"OrderMetadata"},"OrderItemMetadata":{"type":"object","properties":{"apiKey":{"type":"string","description":"API key associated with the order item."},"orderStatus":{"type":"string","description":"Current status of the order item."},"productManufacturer":{"type":"string","description":"Name of the manufacturer for the product."},"productModel":{"type":"string","description":"Model of the product."},"publicKey":{"type":"string","description":"Public key associated with the product or order item."},"salesforceCaseNumber":{"type":"string","description":"Salesforce case number related to the order item."},"serialNumber":{"type":"string","description":"Serial number of the product."},"storeNumber":{"type":"integer","format":"int32","description":"Store number of the product."},"tcn":{"type":"string","description":"Transaction control number related to the item."},"terminalId":{"type":"integer","format":"int32","description":"Terminal ID associated with the product or order."},"trackingNumber":{"type":"string","description":"Tracking number for shipping the product."},"vNumber":{"type":"string","description":"Version number or internal reference number for the order item."}},"title":"OrderItemMetadata"}}}} ``` ## The OrderMetadataRequest object ```json {"openapi":"3.1.1","info":{"title":"Equipment Order","version":"2.0"},"components":{"schemas":{"OrderMetadataRequest":{"type":"object","properties":{"merchantId":{"type":"string"},"metadata":{"$ref":"#/components/schemas/Metadata"},"orderId":{"type":"string"},"orderItemsMetadata":{"type":"array","items":{"$ref":"#/components/schemas/OrderMetadata"}},"status":{"type":"string","enum":["Active","Submitted","Signed","Approved","AddedSalesforce","BoardedTSYS","BoardedQuest","Shipped","BackOrdered","Deleted","Completed","OffRamp","WaitingForTracking","BoardedDevice"]}},"title":"OrderMetadataRequest"},"Metadata":{"type":"object","properties":{"exchangeId":{"type":"string","description":"Unique correlation ID for the order request."},"timestamp":{"type":"string","description":"Timestamp of when the order request was generated. Format: yyyy-MM-dd'T'hh:mm:ss.SSS"}},"title":"Metadata"},"OrderMetadata":{"type":"object","properties":{"orderItemId":{"type":"integer","format":"int32"},"orderItemMetadata":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemMetadata"}}},"title":"OrderMetadata"},"OrderItemMetadata":{"type":"object","properties":{"apiKey":{"type":"string","description":"API key associated with the order item."},"orderStatus":{"type":"string","description":"Current status of the order item."},"productManufacturer":{"type":"string","description":"Name of the manufacturer for the product."},"productModel":{"type":"string","description":"Model of the product."},"publicKey":{"type":"string","description":"Public key associated with the product or order item."},"salesforceCaseNumber":{"type":"string","description":"Salesforce case number related to the order item."},"serialNumber":{"type":"string","description":"Serial number of the product."},"storeNumber":{"type":"integer","format":"int32","description":"Store number of the product."},"tcn":{"type":"string","description":"Transaction control number related to the item."},"terminalId":{"type":"integer","format":"int32","description":"Terminal ID associated with the product or order."},"trackingNumber":{"type":"string","description":"Tracking number for shipping the product."},"vNumber":{"type":"string","description":"Version number or internal reference number for the order item."}},"title":"OrderItemMetadata"}}}} ``` ## The OrderStatusRequest object ```json {"openapi":"3.1.1","info":{"title":"Equipment Order","version":"2.0"},"components":{"schemas":{"OrderStatusRequest":{"type":"object","properties":{"merchantNumber":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemMetadata"}}},"orderId":{"type":"string"},"resubmit":{"type":"boolean"},"status":{"type":"string","enum":["Active","Submitted","Signed","Approved","AddedSalesforce","BoardedTSYS","BoardedQuest","Shipped","BackOrdered","Deleted","Completed","OffRamp","WaitingForTracking","BoardedDevice"]}},"title":"OrderStatusRequest"},"OrderItemMetadata":{"type":"object","properties":{"apiKey":{"type":"string","description":"API key associated with the order item."},"orderStatus":{"type":"string","description":"Current status of the order item."},"productManufacturer":{"type":"string","description":"Name of the manufacturer for the product."},"productModel":{"type":"string","description":"Model of the product."},"publicKey":{"type":"string","description":"Public key associated with the product or order item."},"salesforceCaseNumber":{"type":"string","description":"Salesforce case number related to the order item."},"serialNumber":{"type":"string","description":"Serial number of the product."},"storeNumber":{"type":"integer","format":"int32","description":"Store number of the product."},"tcn":{"type":"string","description":"Transaction control number related to the item."},"terminalId":{"type":"integer","format":"int32","description":"Terminal ID associated with the product or order."},"trackingNumber":{"type":"string","description":"Tracking number for shipping the product."},"vNumber":{"type":"string","description":"Version number or internal reference number for the order item."}},"title":"OrderItemMetadata"}}}} ``` ## The OrderValidationResponse object ```json {"openapi":"3.1.1","info":{"title":"Equipment Order","version":"2.0"},"components":{"schemas":{"OrderValidationResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}},"merchantNumber":{"type":"string"},"orderForm":{"$ref":"#/components/schemas/EquipmentOrderForm"},"orderId":{"type":"string"}},"title":"OrderValidationResponse"},"ValidationError":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}},"title":"ValidationError"},"EquipmentOrderForm":{"type":"object","properties":{"errors":{"type":"array","description":"Contains validation errors with details about the field and message.","items":{"$ref":"#/components/schemas/ValidationError"}},"merchantNumber":{"type":"string","description":"The unique identifier of the merchant."},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Contains metadata about the order request."},"orderCreateTime":{"$ref":"#/components/schemas/Calendar"},"orderId":{"type":"string","description":"Unique identifier for the order."},"orderItems":{"type":"array","description":"List of items included in the order, such as equipment, software, or accessories.","items":{"$ref":"#/components/schemas/OrderItem"}},"orderModifyTime":{"description":"Details of when the order was last modified, including time zone, week data, and timestamp.","$ref":"#/components/schemas/Calendar"},"resubmit":{"type":"boolean","description":"Indicates if the order is a resubmission."},"status":{"type":"string","description":"Current status of the order. Possible values: Active Submitted Signed Approved AddedSalesforce BoardedTSYS BoardedQuest Shipped BackOrdered Deleted Completed OffRamp WaitingForTracking BoardedDevice","enum":["Active","Submitted","Signed","Approved","AddedSalesforce","BoardedTSYS","BoardedQuest","Shipped","BackOrdered","Deleted","Completed","OffRamp","WaitingForTracking","BoardedDevice"]},"validFrontends":{"type":"array","description":"List of supported frontends for the order.","items":{"type":"string"}}},"title":"EquipmentOrderForm"},"Metadata":{"type":"object","properties":{"exchangeId":{"type":"string","description":"Unique correlation ID for the order request."},"timestamp":{"type":"string","description":"Timestamp of when the order request was generated. Format: yyyy-MM-dd'T'hh:mm:ss.SSS"}},"title":"Metadata"},"Calendar":{"type":"object","properties":{"calendarType":{"type":"string","description":"Type of calendar used."},"fieldsComputed":{"type":"integer","format":"int32","description":"Number of computed calendar fields."},"fieldsNormalized":{"type":"integer","format":"int32","description":"Number of normalized calendar fields."},"firstDayOfWeek":{"type":"integer","format":"int32","description":"The first day of the week (1 = Sunday, 2 = Monday, etc.)."},"lenient":{"type":"boolean","description":"Indicates if the calendar allows lenient parsing."},"minimalDaysInFirstWeek":{"type":"integer","format":"int32","description":"Minimal days required in the first week of the year."},"time":{"type":"string","format":"date-time","description":"The ISO 8601 timestamp of order creation."},"timeInMillis":{"type":"integer","format":"int64","description":"Timestamp in milliseconds."},"timeZone":{"$ref":"#/components/schemas/TimeZone"},"weekCountData":{"$ref":"#/components/schemas/Locale"},"weekDateSupported":{"type":"boolean","description":"Indicates whether the week date system is supported for this calendar."},"weekYear":{"type":"integer","format":"int32","description":"The week-based year of the date."},"weeksInWeekYear":{"type":"integer","format":"int32","description":"Total number of weeks in the week-based year."},"zoneShared":{"type":"boolean","description":"Indicates whether the time zone is shared across calendars."}},"title":"Calendar"},"TimeZone":{"type":"object","description":"Time zone information of the order creation.","properties":{"displayName":{"type":"string","description":"Display name of the time zone."},"dstsavings":{"type":"integer","format":"int32","description":"Daylight saving time offset."},"id":{"type":"string","description":"Time zone ID."},"rawOffset":{"type":"integer","format":"int32","description":"Raw offset from UTC in milliseconds."}},"title":"TimeZone"},"Locale":{"type":"object","description":"Locale and week information for calendar calculations.","properties":{"country":{"type":"string","description":"The country code used for week calculations."},"displayCountry":{"type":"string","description":"Display name of the country."},"displayLanguage":{"type":"string","description":"Display name of the language."},"displayName":{"type":"string","description":"Localized display name for the calendar/locale."},"displayScript":{"type":"string","description":"Display name of the script used."},"displayVariant":{"type":"string","description":"Display variant of the locale."},"extensionKeys":{"type":"array","description":"Extension keys for additional locale information.","items":{"$ref":"#/components/schemas/Character"}},"iso3Country":{"type":"string","description":"ISO 3166-1 alpha-3 country code."},"iso3Language":{"type":"string","description":"ISO 639-2 language code."},"language":{"type":"string","description":"Language code for the locale."},"script":{"type":"string","description":"Script code for the locale."},"unicodeLocaleAttributes":{"type":"array","description":"Unicode locale attributes for the calendar.","items":{"type":"string"}},"unicodeLocaleKeys":{"type":"array","description":"Unicode locale keys for the calendar.","items":{"type":"string"}},"variant":{"type":"string","description":"Locale variant information."}},"title":"Locale"},"Character":{"type":"object","title":"Character"},"OrderItem":{"type":"object","description":"List of items included in the order, such as equipment, software, or accessories.","properties":{"completionDate":{"type":"string","description":"Completion date of the order item. Format: MM/dd/yyyy HH:mm a"},"errors":{"type":"array","description":"Errors related to a specific order item.","items":{"$ref":"#/components/schemas/ValidationError"}},"manufacturer":{"type":"string","description":"Name of the equipment manufacturer."},"orderItemId":{"type":"integer","format":"int32","description":"Unique identifier of the order item."},"orderItemMetadata":{"type":"array","description":"Additional metadata about the order item (API key, model, serial number, tracking, etc.).","items":{"$ref":"#/components/schemas/OrderItemMetadata"}},"productName":{"type":"string","description":"Name of the ordered product."},"productType":{"type":"string","description":"Type of the product (Example: Software, Hardware).","enum":["Software","Terminal"]},"quantity":{"type":"integer","format":"int32","description":"Number of units ordered for the product."},"survey":{"$ref":"#/components/schemas/Survey","description":"Equipment survey details linked with the order item."},"surveyValid":{"type":"boolean","description":"Indicates whether the survey data is valid."},"trackingNumber":{"type":"string","description":"Tracking number for the shipment or order item."},"validFrontends":{"type":"array","description":"List of supported frontends for the order item.","items":{"type":"string"}}},"title":"OrderItem"},"OrderItemMetadata":{"type":"object","properties":{"apiKey":{"type":"string","description":"API key associated with the order item."},"orderStatus":{"type":"string","description":"Current status of the order item."},"productManufacturer":{"type":"string","description":"Name of the manufacturer for the product."},"productModel":{"type":"string","description":"Model of the product."},"publicKey":{"type":"string","description":"Public key associated with the product or order item."},"salesforceCaseNumber":{"type":"string","description":"Salesforce case number related to the order item."},"serialNumber":{"type":"string","description":"Serial number of the product."},"storeNumber":{"type":"integer","format":"int32","description":"Store number of the product."},"tcn":{"type":"string","description":"Transaction control number related to the item."},"terminalId":{"type":"integer","format":"int32","description":"Terminal ID associated with the product or order."},"trackingNumber":{"type":"string","description":"Tracking number for shipping the product."},"vNumber":{"type":"string","description":"Version number or internal reference number for the order item."}},"title":"OrderItemMetadata"},"Survey":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/Metadata","description":"Contains metadata about the survey or order request."},"questionAnswerGroup":{"$ref":"#/components/schemas/QuestionAnswerGroup","description":"Contains the structure and data for survey questions and answers."}},"title":"Survey"},"QuestionAnswerGroup":{"type":"object","properties":{"questionAnswerSets":{"type":"object","description":"Holds sets of related questions and their possible answers.","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswerSet"}}},"questionAreas":{"type":"array","description":"Lists the survey question categories or areas being addressed.","items":{"type":"string"}}},"title":"QuestionAnswerGroup"},"QuestionAnswerSet":{"type":"object","properties":{"answers":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswer"}},"children":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswerSet"}},"conditionalOnAnswer":{"type":"integer","format":"int32"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}},"isHidden":{"type":"boolean"},"question":{"type":"string"},"required":{"type":"boolean"},"selectedAnswer":{"type":"integer","format":"int32"},"sendToMerchantApp":{"type":"boolean"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/BoardingTag"}},"type":{"type":"string"},"valid":{"type":"boolean"}},"title":"QuestionAnswerSet"},"QuestionAnswer":{"type":"object","properties":{"answer":{"type":"string"},"id":{"type":"integer","format":"int32"},"selected":{"type":"boolean"}},"title":"QuestionAnswer"},"BoardingTag":{"type":"object","properties":{"group":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}},"title":"BoardingTag"}}}} ``` ## The QuestionAnswer object ```json {"openapi":"3.1.1","info":{"title":"Equipment Order","version":"2.0"},"components":{"schemas":{"QuestionAnswer":{"type":"object","properties":{"answer":{"type":"string"},"id":{"type":"integer","format":"int32"},"selected":{"type":"boolean"}},"title":"QuestionAnswer"}}}} ``` ## The QuestionAnswerGroup object ```json {"openapi":"3.1.1","info":{"title":"Equipment Order","version":"2.0"},"components":{"schemas":{"QuestionAnswerGroup":{"type":"object","properties":{"questionAnswerSets":{"type":"object","description":"Holds sets of related questions and their possible answers.","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswerSet"}}},"questionAreas":{"type":"array","description":"Lists the survey question categories or areas being addressed.","items":{"type":"string"}}},"title":"QuestionAnswerGroup"},"QuestionAnswerSet":{"type":"object","properties":{"answers":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswer"}},"children":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswerSet"}},"conditionalOnAnswer":{"type":"integer","format":"int32"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}},"isHidden":{"type":"boolean"},"question":{"type":"string"},"required":{"type":"boolean"},"selectedAnswer":{"type":"integer","format":"int32"},"sendToMerchantApp":{"type":"boolean"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/BoardingTag"}},"type":{"type":"string"},"valid":{"type":"boolean"}},"title":"QuestionAnswerSet"},"QuestionAnswer":{"type":"object","properties":{"answer":{"type":"string"},"id":{"type":"integer","format":"int32"},"selected":{"type":"boolean"}},"title":"QuestionAnswer"},"ValidationError":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}},"title":"ValidationError"},"BoardingTag":{"type":"object","properties":{"group":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}},"title":"BoardingTag"}}}} ``` ## The QuestionAnswerSet object ```json {"openapi":"3.1.1","info":{"title":"Equipment Order","version":"2.0"},"components":{"schemas":{"QuestionAnswerSet":{"type":"object","properties":{"answers":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswer"}},"children":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswerSet"}},"conditionalOnAnswer":{"type":"integer","format":"int32"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}},"isHidden":{"type":"boolean"},"question":{"type":"string"},"required":{"type":"boolean"},"selectedAnswer":{"type":"integer","format":"int32"},"sendToMerchantApp":{"type":"boolean"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/BoardingTag"}},"type":{"type":"string"},"valid":{"type":"boolean"}},"title":"QuestionAnswerSet"},"QuestionAnswer":{"type":"object","properties":{"answer":{"type":"string"},"id":{"type":"integer","format":"int32"},"selected":{"type":"boolean"}},"title":"QuestionAnswer"},"ValidationError":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}},"title":"ValidationError"},"BoardingTag":{"type":"object","properties":{"group":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}},"title":"BoardingTag"}}}} ``` ## The Survey object ```json {"openapi":"3.1.1","info":{"title":"Equipment Order","version":"2.0"},"components":{"schemas":{"Survey":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/Metadata","description":"Contains metadata about the survey or order request."},"questionAnswerGroup":{"$ref":"#/components/schemas/QuestionAnswerGroup","description":"Contains the structure and data for survey questions and answers."}},"title":"Survey"},"Metadata":{"type":"object","properties":{"exchangeId":{"type":"string","description":"Unique correlation ID for the order request."},"timestamp":{"type":"string","description":"Timestamp of when the order request was generated. Format: yyyy-MM-dd'T'hh:mm:ss.SSS"}},"title":"Metadata"},"QuestionAnswerGroup":{"type":"object","properties":{"questionAnswerSets":{"type":"object","description":"Holds sets of related questions and their possible answers.","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswerSet"}}},"questionAreas":{"type":"array","description":"Lists the survey question categories or areas being addressed.","items":{"type":"string"}}},"title":"QuestionAnswerGroup"},"QuestionAnswerSet":{"type":"object","properties":{"answers":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswer"}},"children":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswerSet"}},"conditionalOnAnswer":{"type":"integer","format":"int32"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}},"isHidden":{"type":"boolean"},"question":{"type":"string"},"required":{"type":"boolean"},"selectedAnswer":{"type":"integer","format":"int32"},"sendToMerchantApp":{"type":"boolean"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/BoardingTag"}},"type":{"type":"string"},"valid":{"type":"boolean"}},"title":"QuestionAnswerSet"},"QuestionAnswer":{"type":"object","properties":{"answer":{"type":"string"},"id":{"type":"integer","format":"int32"},"selected":{"type":"boolean"}},"title":"QuestionAnswer"},"ValidationError":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}},"title":"ValidationError"},"BoardingTag":{"type":"object","properties":{"group":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}},"title":"BoardingTag"}}}} ``` ## The TimeZone object ```json {"openapi":"3.1.1","info":{"title":"Equipment Order","version":"2.0"},"components":{"schemas":{"TimeZone":{"type":"object","description":"Time zone information of the order creation.","properties":{"displayName":{"type":"string","description":"Display name of the time zone."},"dstsavings":{"type":"integer","format":"int32","description":"Daylight saving time offset."},"id":{"type":"string","description":"Time zone ID."},"rawOffset":{"type":"integer","format":"int32","description":"Raw offset from UTC in milliseconds."}},"title":"TimeZone"}}}} ``` ## The ValidationError object ```json {"openapi":"3.1.1","info":{"title":"Equipment Order","version":"2.0"},"components":{"schemas":{"ValidationError":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}},"title":"ValidationError"}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/equipment/equipment-order/models.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.