orderCreate
This service will send an order and return a confirmation. We DO NOT ship to a PO Box. Sending a PO Box in the address field will only delay the order.
WSDL LinkBasic Request elements
| element | Value |
|---|---|
| xmlUser | assigned by Encompass |
| xmlPassword | assigned by Encompass |
| serviceName | XML.ORDER.CREATE |
| serviceMode | SOAP |
Additional Request elements
| element | required | description | sample data |
|---|---|---|---|
| customerType | n | customer type (not used for all accounts) | SERVICEGROUP |
| customerNumber | y | customer number | 12345 |
| customerPassword | n | customer password | testpass |
| useCustomerCross | n | map your customer number to ours (not available for all accounts) (y/n) | n |
| referenceNumber1 | y | main reference number | 123456 |
| transactionID | conditional | required if you allow duplicate referenceNumber1 to prevent duplicate transactions | 1 |
| referenceNumber2 | n | alternate reference number or claim number | |
| shippingMethod | n | shipping method | null=Customer Default 1=Ground 2=2 Day - Allow downgrade to ground if destination is within 2 day ground service area to save money 6=2 Day - No downgrade to ground service 3=Next Day - No downgrade to ground service 7=Next Day - Allow downgrade to ground if destination is within 1 day ground service area to save money 5=3 Day |
| shippingThirdPartyNumber | n | third party shipping account number | xyz123 |
| shippingThirdPartyCarrier | conditional | third party shipping carrier | required if you send a shippingThirdPartyNumber 1=FedEx 2=UPS |
| useBillToAddress | conditional | shipping address info not required if this is "y" (y/n) | n |
| residentialAddress | n | residential address (y/n) | |
| requireSignature | n | require signature for delivery (y/n) - additional freight charges will apply | |
| shipComplete | n | ship order complete(y/n) | Y/N |
| shipToName | n | ship to name | Joe Customer |
| shipToAddress1 | n | address line 1 | 7060 State Road 84 |
| shipToAddress2 | n | address line 1 | Suite 12 |
| shipToCity | n | city | Fort Lauderdale |
| shipToState | n | 2 character ISO state code | FL |
| shipToZip | n | 5 digit zip code | 33317 |
| shipToCountryCode | n | 2 character ISO country code | US |
| shipToPhone | n | phone number without non-numeric characters | 9547239191 |
| requestReturnService | n | add return service label (y/n) (fees might apply) | y |
| emailAddress | n | address for confirmation email | [email protected] |
| partlist | y | array of parts information | see partlist array elements table |
| customOrderField | n | this element can be repeated | test data |
partlist array elements
| element | required | description | sample data |
|---|---|---|---|
| pid | conditional | internal part id used for ordering (see Part Number Notes) | 5937132 |
| mfgCode | conditional | manufacturer code (see Part Number Notes) | MSC |
| partNumber | conditional | part number (see Part Number Notes) | ET-LAB10 |
| orderQuantity | y | quantity of part to order | 3 |
| authorizationOrReferenceNumber | n | part reference number or manufacturer authorization | 459835793 |
| claimsProcessorCode | conditional | Send this only if you want Encompass to send information to a claim processor | 4=Assurant 2=ServiceBench |
| claimNumber | conditional | Send this only if you want Encompass to send information to any of the above claim processors | c12345678 |
| allowAutoSub | Can we auto substitute the part if you send the order with an old part number(Y/N)? This defaults to no, so that you always order the correct part and you know the price up-front. | N | |
| customPartField | n | this element can be repeated | test data |
There are 2 methods for sending the "pid", "mfgCode", and "partNumber" combination.
Preferred method: Send the "pid" that is returned from our "Parts Info" service. You can also send the "mfgCode" and "partNumber" as a backup, but it is not required for this method.
Alternative method: Do not send the "pid", just send the "mfgCode" and "partNumber".
Returned elements
| element | description | sample data |
|---|---|---|
| This service does not return any elements. | ||
Service errorCode values
| errorCode | errorMessage |
|---|---|
| 100 | SUCCESS |
| -200 | files did not open (host issue) |
| -201 | invalid xmlUser |
| -202 | invalid customer number from customer cross |
| -203 | customer number is required |
| -204 | invalid customer number |
| -205 | referenceNumber1 is required |
| -206 | duplicate referenceNumber1 |
| -207 | transactionID is required |
| -208 | invalid part |
| -209 | invalid pid |
| -210 | has a substitute part |
| -211 | an invalid orderQuantity |
| -212 | has a minimum order qty |
| -213 | no valid parts were submitted |
| -214 | is not available for backorder |
| -215 | is not available for resale |
| -216 | is not available for country |
| -217 | account does not allow backorder |
| -218 | n/a |
| -219 | n/a |
| -220 | requires manufacturer authorization in authorizationOrReferenceNumber |
| -221 | n/a |
| -222 | Invalid shipToCountryCode |
| -223 | requires shipToState for country |
| -224 | Invalid shipToState |
| -225 | Invalid shippingThirdPartyCarrier |
| -226 | account has been closed |
| -227 | Invalid shippingThirdPartyNumber |
| -228 | Invalid shipToPhone |
| -229 | password is required |
| -230 | password is invalid |
| -231 | Invalid claimsProcessorCode or claimNumber |
This documentation is only designed as a guide for the corresponding WSDL file.