POST api/Codat/PostSupplier

API to import orders from shopify

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SupplierID	integer	None.
CodatSupplierId	string	None.
SupplierName	string	None.
ContactName	string	None.
DefaultCurrency	string	None.
Phone	string	None.
EmailAddress	string	None.
AddressLine1	string	None.
AddressLine2	string	None.
City	string	None.
Region	string	None.
Country	string	None.
PostalCode	string	None.
Status	string	None.
InCopanySupplier	boolean	None.

Request Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "supplierID": 1,
  "codatSupplierId": "sample string 2",
  "supplierName": "sample string 3",
  "contactName": "sample string 4",
  "defaultCurrency": "sample string 5",
  "phone": "sample string 6",
  "emailAddress": "sample string 7",
  "addressLine1": "sample string 8",
  "addressLine2": "sample string 9",
  "city": "sample string 10",
  "region": "sample string 11",
  "country": "sample string 12",
  "postalCode": "sample string 13",
  "status": "sample string 14",
  "inCopanySupplier": true
}

application/xml, text/xml

Sample:

<CodatSupplierRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel">
  <AddressLine1>sample string 8</AddressLine1>
  <AddressLine2>sample string 9</AddressLine2>
  <City>sample string 10</City>
  <CodatSupplierId>sample string 2</CodatSupplierId>
  <ContactName>sample string 4</ContactName>
  <Country>sample string 12</Country>
  <DefaultCurrency>sample string 5</DefaultCurrency>
  <EmailAddress>sample string 7</EmailAddress>
  <InCopanySupplier>true</InCopanySupplier>
  <Phone>sample string 6</Phone>
  <PostalCode>sample string 13</PostalCode>
  <Region>sample string 11</Region>
  <Status>sample string 14</Status>
  <SupplierID>1</SupplierID>
  <SupplierName>sample string 3</SupplierName>
</CodatSupplierRequestModel>

multipart/form-data

Sample:

<CodatSupplierRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel"><AddressLine1>sample string 8</AddressLine1><AddressLine2>sample string 9</AddressLine2><City>sample string 10</City><CodatSupplierId>sample string 2</CodatSupplierId><ContactName>sample string 4</ContactName><Country>sample string 12</Country><DefaultCurrency>sample string 5</DefaultCurrency><EmailAddress>sample string 7</EmailAddress><InCopanySupplier>true</InCopanySupplier><Phone>sample string 6</Phone><PostalCode>sample string 13</PostalCode><Region>sample string 11</Region><Status>sample string 14</Status><SupplierID>1</SupplierID><SupplierName>sample string 3</SupplierName></CodatSupplierRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CommonResponseDataModel

Name	Type	Additional information
ReturnID	integer	Required
Message	string	Required
Successful	boolean	Required
Code	integer	None.
TotalRecord	integer	None.

Response Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "returnID": 1,
  "message": "sample string 2",
  "successful": true,
  "code": 4,
  "totalRecord": 5
}

application/xml, text/xml

Sample:

<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">
  <Code>4</Code>
  <Message>sample string 2</Message>
  <ReturnID>1</ReturnID>
  <Successful>true</Successful>
  <TotalRecord>5</TotalRecord>
</CommonResponseDataModel>

multipart/form-data

Sample:

<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"><Code>4</Code><Message>sample string 2</Message><ReturnID>1</ReturnID><Successful>true</Successful><TotalRecord>5</TotalRecord></CommonResponseDataModel>