Equipment Order Controller
Service to post an order
Body
merchantNumberstringOptional
orderIdstringOptional
resubmitbooleanOptional
statusstring · enumOptionalPossible values:
validFrontendsstring[]Optional
Responses
200
OK
201
Success
400
Validation failure
401
Unauthorized
403
Forbidden
404
Not Found
500
unknown exception
post
POST //api/equipment/orders HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/xml
Accept: */*
Content-Length: 2269
"<?xml version=1.0?>
<errors>
<field>text</field>
<message>text</message>
</errors>
<merchantNumber>text</merchantNumber>
<metadata>
<exchangeId>text</exchangeId>
<timestamp>text</timestamp>
</metadata>
<orderCreateTime>
<calendarType>text</calendarType>
<fieldsComputed>1</fieldsComputed>
<fieldsNormalized>1</fieldsNormalized>
<firstDayOfWeek>1</firstDayOfWeek>
<lenient>true</lenient>
<minimalDaysInFirstWeek>1</minimalDaysInFirstWeek>
<time>2025-07-09T04:03:33.863Z</time>
<timeInMillis>1</timeInMillis>
<timeZone>
<displayName>text</displayName>
<dstsavings>1</dstsavings>
<id>text</id>
<rawOffset>1</rawOffset>
</timeZone>
<weekCountData>
<country>text</country>
<displayCountry>text</displayCountry>
<displayLanguage>text</displayLanguage>
<displayName>text</displayName>
<displayScript>text</displayScript>
<displayVariant>text</displayVariant>
<extensionKeys/>
<iso3Country>text</iso3Country>
<iso3Language>text</iso3Language>
<language>text</language>
<script>text</script>
<unicodeLocaleAttributes>text</unicodeLocaleAttributes>
<unicodeLocaleKeys>text</unicodeLocaleKeys>
<variant>text</variant>
</weekCountData>
<weekDateSupported>true</weekDateSupported>
<weekYear>1</weekYear>
<weeksInWeekYear>1</weeksInWeekYear>
<zoneShared>true</zoneShared>
</orderCreateTime>
<orderId>text</orderId>
<orderItems>
<completionDate>MM/dd/yyyy HH:mm a</completionDate>
<errors>
<field>text</field>
<message>text</message>
</errors>
<manufacturer>text</manufacturer>
<orderItemId>1</orderItemId>
<orderItemMetadata>
<apiKey>text</apiKey>
<orderStatus>text</orderStatus>
<productManufacturer>text</productManufacturer>
<productModel>text</productModel>
<publicKey>text</publicKey>
<salesforceCaseNumber>text</salesforceCaseNumber>
<serialNumber>text</serialNumber>
<storeNumber>1</storeNumber>
<tcn>text</tcn>
<terminalId>1</terminalId>
<trackingNumber>text</trackingNumber>
<vNumber>text</vNumber>
</orderItemMetadata>
<productName>text</productName>
<productType>Software</productType>
<quantity>1</quantity>
<survey>
<metadata>
<exchangeId>text</exchangeId>
<timestamp>text</timestamp>
</metadata>
<questionAnswerGroup>
<questionAnswerSets>
<ANY_ADDITIONAL_PROPERTY>[Circular Reference]</ANY_ADDITIONAL_PROPERTY>
</questionAnswerSets>
<questionAreas>text</questionAreas>
</questionAnswerGroup>
</survey>
<surveyValid>true</surveyValid>
<trackingNumber>text</trackingNumber>
<validFrontends>text</validFrontends>
</orderItems>
<orderModifyTime>
<calendarType>text</calendarType>
<fieldsComputed>1</fieldsComputed>
<fieldsNormalized>1</fieldsNormalized>
<firstDayOfWeek>1</firstDayOfWeek>
<lenient>true</lenient>
<minimalDaysInFirstWeek>1</minimalDaysInFirstWeek>
<time>2025-07-09T04:03:33.863Z</time>
<timeInMillis>1</timeInMillis>
<timeZone>
<displayName>text</displayName>
<dstsavings>1</dstsavings>
<id>text</id>
<rawOffset>1</rawOffset>
</timeZone>
<weekCountData>
<country>text</country>
<displayCountry>text</displayCountry>
<displayLanguage>text</displayLanguage>
<displayName>text</displayName>
<displayScript>text</displayScript>
<displayVariant>text</displayVariant>
<extensionKeys/>
<iso3Country>text</iso3Country>
<iso3Language>text</iso3Language>
<language>text</language>
<script>text</script>
<unicodeLocaleAttributes>text</unicodeLocaleAttributes>
<unicodeLocaleKeys>text</unicodeLocaleKeys>
<variant>text</variant>
</weekCountData>
<weekDateSupported>true</weekDateSupported>
<weekYear>1</weekYear>
<weeksInWeekYear>1</weeksInWeekYear>
<zoneShared>true</zoneShared>
</orderModifyTime>
<resubmit>true</resubmit>
<status>Active</status>
<validFrontends>text</validFrontends>
"
<?xml version="1.0"?>
<object>
<errors>
<field>text</field>
<message>text</message>
</errors>
<merchantNumber>text</merchantNumber>
<metadata>
<exchangeId>text</exchangeId>
<timestamp>text</timestamp>
</metadata>
<orderCreateTime>
<calendarType>text</calendarType>
<fieldsComputed>1</fieldsComputed>
<fieldsNormalized>1</fieldsNormalized>
<firstDayOfWeek>1</firstDayOfWeek>
<lenient>true</lenient>
<minimalDaysInFirstWeek>1</minimalDaysInFirstWeek>
<time>2025-07-09T04:03:33.863Z</time>
<timeInMillis>1</timeInMillis>
<timeZone>
<displayName>text</displayName>
<dstsavings>1</dstsavings>
<id>text</id>
<rawOffset>1</rawOffset>
</timeZone>
<weekCountData>
<country>text</country>
<displayCountry>text</displayCountry>
<displayLanguage>text</displayLanguage>
<displayName>text</displayName>
<displayScript>text</displayScript>
<displayVariant>text</displayVariant>
<extensionKeys/>
<iso3Country>text</iso3Country>
<iso3Language>text</iso3Language>
<language>text</language>
<script>text</script>
<unicodeLocaleAttributes>text</unicodeLocaleAttributes>
<unicodeLocaleKeys>text</unicodeLocaleKeys>
<variant>text</variant>
</weekCountData>
<weekDateSupported>true</weekDateSupported>
<weekYear>1</weekYear>
<weeksInWeekYear>1</weeksInWeekYear>
<zoneShared>true</zoneShared>
</orderCreateTime>
<orderId>text</orderId>
<orderItems>
<completionDate>MM/dd/yyyy HH:mm a</completionDate>
<errors>
<field>text</field>
<message>text</message>
</errors>
<manufacturer>text</manufacturer>
<orderItemId>1</orderItemId>
<orderItemMetadata>
<apiKey>text</apiKey>
<orderStatus>text</orderStatus>
<productManufacturer>text</productManufacturer>
<productModel>text</productModel>
<publicKey>text</publicKey>
<salesforceCaseNumber>text</salesforceCaseNumber>
<serialNumber>text</serialNumber>
<storeNumber>1</storeNumber>
<tcn>text</tcn>
<terminalId>1</terminalId>
<trackingNumber>text</trackingNumber>
<vNumber>text</vNumber>
</orderItemMetadata>
<productName>text</productName>
<productType>Software</productType>
<quantity>1</quantity>
<survey>
<metadata>
<exchangeId>text</exchangeId>
<timestamp>text</timestamp>
</metadata>
<questionAnswerGroup>
<questionAnswerSets>
<ANY_ADDITIONAL_PROPERTY>[Circular Reference]</ANY_ADDITIONAL_PROPERTY>
</questionAnswerSets>
<questionAreas>text</questionAreas>
</questionAnswerGroup>
</survey>
<surveyValid>true</surveyValid>
<trackingNumber>text</trackingNumber>
<validFrontends>text</validFrontends>
</orderItems>
<orderModifyTime>
<calendarType>text</calendarType>
<fieldsComputed>1</fieldsComputed>
<fieldsNormalized>1</fieldsNormalized>
<firstDayOfWeek>1</firstDayOfWeek>
<lenient>true</lenient>
<minimalDaysInFirstWeek>1</minimalDaysInFirstWeek>
<time>2025-07-09T04:03:33.863Z</time>
<timeInMillis>1</timeInMillis>
<timeZone>
<displayName>text</displayName>
<dstsavings>1</dstsavings>
<id>text</id>
<rawOffset>1</rawOffset>
</timeZone>
<weekCountData>
<country>text</country>
<displayCountry>text</displayCountry>
<displayLanguage>text</displayLanguage>
<displayName>text</displayName>
<displayScript>text</displayScript>
<displayVariant>text</displayVariant>
<extensionKeys/>
<iso3Country>text</iso3Country>
<iso3Language>text</iso3Language>
<language>text</language>
<script>text</script>
<unicodeLocaleAttributes>text</unicodeLocaleAttributes>
<unicodeLocaleKeys>text</unicodeLocaleKeys>
<variant>text</variant>
</weekCountData>
<weekDateSupported>true</weekDateSupported>
<weekYear>1</weekYear>
<weeksInWeekYear>1</weeksInWeekYear>
<zoneShared>true</zoneShared>
</orderModifyTime>
<resubmit>true</resubmit>
<status>Active</status>
<validFrontends>text</validFrontends>
</object>
Path parameters
merchantanyRequired
merchant
Query parameters
merchAppFilteranyOptional
merchAppFilter
orderTypeanyOptional
orderType
Responses
200
Success
401
Unauthorized
403
Forbidden
404
Not Found
500
unknown exception
get
GET //api/equipment/orders/{merchant} HTTP/1.1
Host: gateway-sb.clearent.net
Accept: */*
<?xml version="1.0"?>
<object>
<errors>
<field>text</field>
<message>text</message>
</errors>
<merchantNumber>text</merchantNumber>
<metadata>
<exchangeId>text</exchangeId>
<timestamp>text</timestamp>
</metadata>
<orderCreateTime>
<calendarType>text</calendarType>
<fieldsComputed>1</fieldsComputed>
<fieldsNormalized>1</fieldsNormalized>
<firstDayOfWeek>1</firstDayOfWeek>
<lenient>true</lenient>
<minimalDaysInFirstWeek>1</minimalDaysInFirstWeek>
<time>2025-07-09T04:03:33.863Z</time>
<timeInMillis>1</timeInMillis>
<timeZone>
<displayName>text</displayName>
<dstsavings>1</dstsavings>
<id>text</id>
<rawOffset>1</rawOffset>
</timeZone>
<weekCountData>
<country>text</country>
<displayCountry>text</displayCountry>
<displayLanguage>text</displayLanguage>
<displayName>text</displayName>
<displayScript>text</displayScript>
<displayVariant>text</displayVariant>
<extensionKeys/>
<iso3Country>text</iso3Country>
<iso3Language>text</iso3Language>
<language>text</language>
<script>text</script>
<unicodeLocaleAttributes>text</unicodeLocaleAttributes>
<unicodeLocaleKeys>text</unicodeLocaleKeys>
<variant>text</variant>
</weekCountData>
<weekDateSupported>true</weekDateSupported>
<weekYear>1</weekYear>
<weeksInWeekYear>1</weeksInWeekYear>
<zoneShared>true</zoneShared>
</orderCreateTime>
<orderId>text</orderId>
<orderItems>
<completionDate>MM/dd/yyyy HH:mm a</completionDate>
<errors>
<field>text</field>
<message>text</message>
</errors>
<manufacturer>text</manufacturer>
<orderItemId>1</orderItemId>
<orderItemMetadata>
<apiKey>text</apiKey>
<orderStatus>text</orderStatus>
<productManufacturer>text</productManufacturer>
<productModel>text</productModel>
<publicKey>text</publicKey>
<salesforceCaseNumber>text</salesforceCaseNumber>
<serialNumber>text</serialNumber>
<storeNumber>1</storeNumber>
<tcn>text</tcn>
<terminalId>1</terminalId>
<trackingNumber>text</trackingNumber>
<vNumber>text</vNumber>
</orderItemMetadata>
<productName>text</productName>
<productType>Software</productType>
<quantity>1</quantity>
<survey>
<metadata>
<exchangeId>text</exchangeId>
<timestamp>text</timestamp>
</metadata>
<questionAnswerGroup>
<questionAnswerSets>
<ANY_ADDITIONAL_PROPERTY>[Circular Reference]</ANY_ADDITIONAL_PROPERTY>
</questionAnswerSets>
<questionAreas>text</questionAreas>
</questionAnswerGroup>
</survey>
<surveyValid>true</surveyValid>
<trackingNumber>text</trackingNumber>
<validFrontends>text</validFrontends>
</orderItems>
<orderModifyTime>
<calendarType>text</calendarType>
<fieldsComputed>1</fieldsComputed>
<fieldsNormalized>1</fieldsNormalized>
<firstDayOfWeek>1</firstDayOfWeek>
<lenient>true</lenient>
<minimalDaysInFirstWeek>1</minimalDaysInFirstWeek>
<time>2025-07-09T04:03:33.863Z</time>
<timeInMillis>1</timeInMillis>
<timeZone>
<displayName>text</displayName>
<dstsavings>1</dstsavings>
<id>text</id>
<rawOffset>1</rawOffset>
</timeZone>
<weekCountData>
<country>text</country>
<displayCountry>text</displayCountry>
<displayLanguage>text</displayLanguage>
<displayName>text</displayName>
<displayScript>text</displayScript>
<displayVariant>text</displayVariant>
<extensionKeys/>
<iso3Country>text</iso3Country>
<iso3Language>text</iso3Language>
<language>text</language>
<script>text</script>
<unicodeLocaleAttributes>text</unicodeLocaleAttributes>
<unicodeLocaleKeys>text</unicodeLocaleKeys>
<variant>text</variant>
</weekCountData>
<weekDateSupported>true</weekDateSupported>
<weekYear>1</weekYear>
<weeksInWeekYear>1</weeksInWeekYear>
<zoneShared>true</zoneShared>
</orderModifyTime>
<resubmit>true</resubmit>
<status>Active</status>
<validFrontends>text</validFrontends>
</object>
Path parameters
merchantanyRequired
merchant
orderIdanyRequired
orderId
Responses
200
Success
204
No Content
401
Unauthorized
403
Forbidden
500
unknown exception
delete
DELETE //api/equipment/orders/{merchant}/order/{orderId} HTTP/1.1
Host: gateway-sb.clearent.net
Accept: */*
No content
Path parameters
merchantanyRequired
merchant
orderNumberanyRequired
orderNumber
Query parameters
merchAppFilteranyOptional
merchAppFilter
Responses
200
Success
401
Unauthorized
403
Forbidden
404
Not Found
500
unknown exception
get
GET //api/equipment/orders/{merchant}/order/{orderNumber} HTTP/1.1
Host: gateway-sb.clearent.net
Accept: */*
<?xml version="1.0"?>
<object>
<errors>
<field>text</field>
<message>text</message>
</errors>
<merchantNumber>text</merchantNumber>
<metadata>
<exchangeId>text</exchangeId>
<timestamp>text</timestamp>
</metadata>
<orderCreateTime>
<calendarType>text</calendarType>
<fieldsComputed>1</fieldsComputed>
<fieldsNormalized>1</fieldsNormalized>
<firstDayOfWeek>1</firstDayOfWeek>
<lenient>true</lenient>
<minimalDaysInFirstWeek>1</minimalDaysInFirstWeek>
<time>2025-07-09T04:03:33.863Z</time>
<timeInMillis>1</timeInMillis>
<timeZone>
<displayName>text</displayName>
<dstsavings>1</dstsavings>
<id>text</id>
<rawOffset>1</rawOffset>
</timeZone>
<weekCountData>
<country>text</country>
<displayCountry>text</displayCountry>
<displayLanguage>text</displayLanguage>
<displayName>text</displayName>
<displayScript>text</displayScript>
<displayVariant>text</displayVariant>
<extensionKeys/>
<iso3Country>text</iso3Country>
<iso3Language>text</iso3Language>
<language>text</language>
<script>text</script>
<unicodeLocaleAttributes>text</unicodeLocaleAttributes>
<unicodeLocaleKeys>text</unicodeLocaleKeys>
<variant>text</variant>
</weekCountData>
<weekDateSupported>true</weekDateSupported>
<weekYear>1</weekYear>
<weeksInWeekYear>1</weeksInWeekYear>
<zoneShared>true</zoneShared>
</orderCreateTime>
<orderId>text</orderId>
<orderItems>
<completionDate>MM/dd/yyyy HH:mm a</completionDate>
<errors>
<field>text</field>
<message>text</message>
</errors>
<manufacturer>text</manufacturer>
<orderItemId>1</orderItemId>
<orderItemMetadata>
<apiKey>text</apiKey>
<orderStatus>text</orderStatus>
<productManufacturer>text</productManufacturer>
<productModel>text</productModel>
<publicKey>text</publicKey>
<salesforceCaseNumber>text</salesforceCaseNumber>
<serialNumber>text</serialNumber>
<storeNumber>1</storeNumber>
<tcn>text</tcn>
<terminalId>1</terminalId>
<trackingNumber>text</trackingNumber>
<vNumber>text</vNumber>
</orderItemMetadata>
<productName>text</productName>
<productType>Software</productType>
<quantity>1</quantity>
<survey>
<metadata>
<exchangeId>text</exchangeId>
<timestamp>text</timestamp>
</metadata>
<questionAnswerGroup>
<questionAnswerSets>
<ANY_ADDITIONAL_PROPERTY>[Circular Reference]</ANY_ADDITIONAL_PROPERTY>
</questionAnswerSets>
<questionAreas>text</questionAreas>
</questionAnswerGroup>
</survey>
<surveyValid>true</surveyValid>
<trackingNumber>text</trackingNumber>
<validFrontends>text</validFrontends>
</orderItems>
<orderModifyTime>
<calendarType>text</calendarType>
<fieldsComputed>1</fieldsComputed>
<fieldsNormalized>1</fieldsNormalized>
<firstDayOfWeek>1</firstDayOfWeek>
<lenient>true</lenient>
<minimalDaysInFirstWeek>1</minimalDaysInFirstWeek>
<time>2025-07-09T04:03:33.863Z</time>
<timeInMillis>1</timeInMillis>
<timeZone>
<displayName>text</displayName>
<dstsavings>1</dstsavings>
<id>text</id>
<rawOffset>1</rawOffset>
</timeZone>
<weekCountData>
<country>text</country>
<displayCountry>text</displayCountry>
<displayLanguage>text</displayLanguage>
<displayName>text</displayName>
<displayScript>text</displayScript>
<displayVariant>text</displayVariant>
<extensionKeys/>
<iso3Country>text</iso3Country>
<iso3Language>text</iso3Language>
<language>text</language>
<script>text</script>
<unicodeLocaleAttributes>text</unicodeLocaleAttributes>
<unicodeLocaleKeys>text</unicodeLocaleKeys>
<variant>text</variant>
</weekCountData>
<weekDateSupported>true</weekDateSupported>
<weekYear>1</weekYear>
<weeksInWeekYear>1</weeksInWeekYear>
<zoneShared>true</zoneShared>
</orderModifyTime>
<resubmit>true</resubmit>
<status>Active</status>
<validFrontends>text</validFrontends>
</object>
Path parameters
merchantanyRequired
merchant
statusanyRequired
status
Query parameters
merchAppFilteranyOptional
merchAppFilter
orderTypeanyOptional
orderType
Responses
200
Success
401
Unauthorized
403
Forbidden
404
Not Found
500
unknown exception
get
GET //api/equipment/orders/{merchant}/{status} HTTP/1.1
Host: gateway-sb.clearent.net
Accept: */*
<?xml version="1.0"?>
<object>
<errors>
<field>text</field>
<message>text</message>
</errors>
<merchantNumber>text</merchantNumber>
<metadata>
<exchangeId>text</exchangeId>
<timestamp>text</timestamp>
</metadata>
<orderCreateTime>
<calendarType>text</calendarType>
<fieldsComputed>1</fieldsComputed>
<fieldsNormalized>1</fieldsNormalized>
<firstDayOfWeek>1</firstDayOfWeek>
<lenient>true</lenient>
<minimalDaysInFirstWeek>1</minimalDaysInFirstWeek>
<time>2025-07-09T04:03:33.863Z</time>
<timeInMillis>1</timeInMillis>
<timeZone>
<displayName>text</displayName>
<dstsavings>1</dstsavings>
<id>text</id>
<rawOffset>1</rawOffset>
</timeZone>
<weekCountData>
<country>text</country>
<displayCountry>text</displayCountry>
<displayLanguage>text</displayLanguage>
<displayName>text</displayName>
<displayScript>text</displayScript>
<displayVariant>text</displayVariant>
<extensionKeys/>
<iso3Country>text</iso3Country>
<iso3Language>text</iso3Language>
<language>text</language>
<script>text</script>
<unicodeLocaleAttributes>text</unicodeLocaleAttributes>
<unicodeLocaleKeys>text</unicodeLocaleKeys>
<variant>text</variant>
</weekCountData>
<weekDateSupported>true</weekDateSupported>
<weekYear>1</weekYear>
<weeksInWeekYear>1</weeksInWeekYear>
<zoneShared>true</zoneShared>
</orderCreateTime>
<orderId>text</orderId>
<orderItems>
<completionDate>MM/dd/yyyy HH:mm a</completionDate>
<errors>
<field>text</field>
<message>text</message>
</errors>
<manufacturer>text</manufacturer>
<orderItemId>1</orderItemId>
<orderItemMetadata>
<apiKey>text</apiKey>
<orderStatus>text</orderStatus>
<productManufacturer>text</productManufacturer>
<productModel>text</productModel>
<publicKey>text</publicKey>
<salesforceCaseNumber>text</salesforceCaseNumber>
<serialNumber>text</serialNumber>
<storeNumber>1</storeNumber>
<tcn>text</tcn>
<terminalId>1</terminalId>
<trackingNumber>text</trackingNumber>
<vNumber>text</vNumber>
</orderItemMetadata>
<productName>text</productName>
<productType>Software</productType>
<quantity>1</quantity>
<survey>
<metadata>
<exchangeId>text</exchangeId>
<timestamp>text</timestamp>
</metadata>
<questionAnswerGroup>
<questionAnswerSets>
<ANY_ADDITIONAL_PROPERTY>[Circular Reference]</ANY_ADDITIONAL_PROPERTY>
</questionAnswerSets>
<questionAreas>text</questionAreas>
</questionAnswerGroup>
</survey>
<surveyValid>true</surveyValid>
<trackingNumber>text</trackingNumber>
<validFrontends>text</validFrontends>
</orderItems>
<orderModifyTime>
<calendarType>text</calendarType>
<fieldsComputed>1</fieldsComputed>
<fieldsNormalized>1</fieldsNormalized>
<firstDayOfWeek>1</firstDayOfWeek>
<lenient>true</lenient>
<minimalDaysInFirstWeek>1</minimalDaysInFirstWeek>
<time>2025-07-09T04:03:33.863Z</time>
<timeInMillis>1</timeInMillis>
<timeZone>
<displayName>text</displayName>
<dstsavings>1</dstsavings>
<id>text</id>
<rawOffset>1</rawOffset>
</timeZone>
<weekCountData>
<country>text</country>
<displayCountry>text</displayCountry>
<displayLanguage>text</displayLanguage>
<displayName>text</displayName>
<displayScript>text</displayScript>
<displayVariant>text</displayVariant>
<extensionKeys/>
<iso3Country>text</iso3Country>
<iso3Language>text</iso3Language>
<language>text</language>
<script>text</script>
<unicodeLocaleAttributes>text</unicodeLocaleAttributes>
<unicodeLocaleKeys>text</unicodeLocaleKeys>
<variant>text</variant>
</weekCountData>
<weekDateSupported>true</weekDateSupported>
<weekYear>1</weekYear>
<weeksInWeekYear>1</weeksInWeekYear>
<zoneShared>true</zoneShared>
</orderModifyTime>
<resubmit>true</resubmit>
<status>Active</status>
<validFrontends>text</validFrontends>
</object>
Was this helpful?