API Load Companies

HTTP
Method

/<service>/<version>/<parameters>

POST

/companies/v1/submit

Environment

Request URL

UAT

https://ihubuat.supplystream.com:8081/api/companies/v1/submit?api_key=<api_Key>

Live

https://ihub.supplystream.com:8081/api/companies/v1/submit?api_key=<api_Key>

Header

Requirement

JSON

XML

Content-Type

Required

Content-Type: application/json

Content-Type: application/xml

Accept

Optional. Returns Content-Type format if undefined

Accept: application/json

Accept: application/xml

XML Format

Body

<Request>
<Company>
<BranchCode>string</BranchCode>
<CompanyCategory>string</CompanyCategory>
<CompanyCode>string</CompanyCode>
<CompanyDescription>string</CompanyDescription>
<CompanyType>string</CompanyType>
<Notes>string</Notes>
<SpecialInstructions>string</SpecialInstructions>
<CompanyNumber>string</CompanyNumber>
<BusinessNumber>string</BusinessNumber>
<VATNumber>string</VATNumber>
<CurrencyCode>string</CurrencyCode>
<SubsidiaryCode>string</SubsidiaryCode>
<InvoiceFormat>string</InvoiceFormat>
<Airport>string</Airport>
<BillToCode>string</BillToCode>
<BillToName>string</BillToName>
</Company>
<List>
<Address>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<AddressLine3>string</AddressLine3>
<AddressLine4>string</AddressLine4>
<AddressLocationType>string</AddressLocationType>
<AddressType>string</AddressType>
<City>string</City>
<CountryCode>string</CountryCode>
<County>string</County>
<PostcodeZip>string</PostcodeZip>
</Address>
</List>
</Request>

Example success Response Body

<Response>
<CallStatus>
<Success>true</Success>
<Code>0</Code>
<Message></Message>
</CallStatus>
<GUID />
</Response>

Example failure Response Body

<Response>
<CallStatus>
<Success>false</Success>
<Code>100</Code>
<Message>The PostcodeZip field is required.</Message>
</CallStatus>
</Response>

JSON Format

Body

{
"Company": {
"BranchCode": "string",
"CompanyCategory": "string",
"CompanyCode": "string",
"CompanyDescription": "string",
"CompanyType": "string",
"Notes": "string",
"SpecialInstructions": "string",
"CompanyNumber": "string",
"BusinessNumber": "string",
"VATNumber": "string",
"CurrencyCode": "string",
"SubsidiaryCode": "string",
"InvoiceFormat": "string",
"Airport": "string",
"BillToCode": "string",
"BillToName": "string"
},
"List": {
"Address": [
{
"AddressLine1": "string",
"AddressLine2": "string",
"AddressLine3": "string",
"AddressLine4": "string",
"AddressLocationType": "string",
"AddressType": "string",
"City": "string",
"CountryCode": "string",
"County": "string",
"PostcodeZip": "string"
}
]
}
}

Example success Response Body

{
"CallStatus": {
"Success": true,
"Code": 0,
"Message": ""
},
"GUID": null
}

Example failure Response Body

{
"CallStatus": {
"Success": false,
"Code": 100,
"Message": "Error. Company Type not valid."
},
"GUID": null
}