POST api/Codat/PostItem

API to import orders from shopify

Request Information

URI Parameters

None.

Body Parameters

CodatItemRequestModel
NameDescriptionTypeAdditional information
PartsID

integer

None.

ItemCode

string

None.

ItemName

string

None.

ItemDescription

string

None.

CodatItemId

string

None.

ItemPrice

decimal number

None.

TaxRateID

integer

None.

Request Formats

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

Sample:
{
  "partsID": 1,
  "itemCode": "sample string 2",
  "itemName": "sample string 3",
  "itemDescription": "sample string 4",
  "codatItemId": "sample string 5",
  "itemPrice": 6.0,
  "taxRateID": 7
}

application/xml, text/xml

Sample:
<CodatItemRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel">
  <CodatItemId>sample string 5</CodatItemId>
  <ItemCode>sample string 2</ItemCode>
  <ItemDescription>sample string 4</ItemDescription>
  <ItemName>sample string 3</ItemName>
  <ItemPrice>6</ItemPrice>
  <PartsID>1</PartsID>
  <TaxRateID>7</TaxRateID>
</CodatItemRequestModel>

multipart/form-data

Sample:
<CodatItemRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel"><CodatItemId>sample string 5</CodatItemId><ItemCode>sample string 2</ItemCode><ItemDescription>sample string 4</ItemDescription><ItemName>sample string 3</ItemName><ItemPrice>6</ItemPrice><PartsID>1</PartsID><TaxRateID>7</TaxRateID></CodatItemRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CommonResponseDataModel
NameDescriptionTypeAdditional 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>