POST api/v1/CreateDocument
Request Information
URI Parameters
None.
Body Parameters
CreateDocumentRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| credential | Credential |
None. |
|
| DocumentDetail | DocumentDetail |
None. |
|
| ArticleDetail | Collection of ArticleDetail |
None. |
|
| ShippingTypeCode | string |
None. |
|
| stateOfOrder | string |
None. |
|
| Address | string |
None. |
|
| ZipCode | string |
None. |
|
| Location | string |
None. |
|
| Remarks | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"credential": {
"CompanyCode": "sample string 1",
"CompanyName": "sample string 2",
"UserLogin": "sample string 3",
"UserPassword": "sample string 4",
"DropDate": "sample string 5",
"WebServiceURL": "sample string 6",
"PageNumber": 7,
"EntityCode": 8,
"ConnectionString": "sample string 9",
"TerminalNo": "sample string 10",
"PhoneNumber": "sample string 11"
},
"DocumentDetail": {
"Credential": {
"CompanyCode": "sample string 1",
"CompanyName": "sample string 2",
"UserLogin": "sample string 3",
"UserPassword": "sample string 4",
"DropDate": "sample string 5",
"WebServiceURL": "sample string 6",
"PageNumber": 7,
"EntityCode": 8,
"ConnectionString": "sample string 9",
"TerminalNo": "sample string 10",
"PhoneNumber": "sample string 11"
},
"SourceWarehouseCode": "sample string 1",
"TargetWarehouseCode": "sample string 2",
"DocumentTypeCode": "sample string 3",
"EntityCode": "sample string 4",
"IsPOS": "sample string 5",
"IsExternal": "sample string 6",
"DocumentId": "sample string 7",
"ArticleCode": "sample string 8",
"Quantity": 9,
"ArticleDesignation": "sample string 10"
},
"ArticleDetail": [
{
"ArticleCode": "sample string 1",
"ArticleDesignation": "sample string 2",
"Quantity": "sample string 3",
"UnitaryPriceWithoutTaxesBeforeDiscounts": 4.1,
"DiscountPercentage1": 5.1
},
{
"ArticleCode": "sample string 1",
"ArticleDesignation": "sample string 2",
"Quantity": "sample string 3",
"UnitaryPriceWithoutTaxesBeforeDiscounts": 4.1,
"DiscountPercentage1": 5.1
}
],
"ShippingTypeCode": "sample string 1",
"stateOfOrder": "sample string 2",
"Address": "sample string 3",
"ZipCode": "sample string 4",
"Location": "sample string 5",
"Remarks": "sample string 6"
}
application/xml, text/xml
Sample:
<CreateDocumentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WinMax4API.Models.Request">
<Address>sample string 3</Address>
<Location>sample string 5</Location>
<Remarks>sample string 6</Remarks>
<ZipCode>sample string 4</ZipCode>
<ArticleDetail xmlns:d2p1="http://schemas.datacontract.org/2004/07/WinMax4API.Models">
<d2p1:ArticleDetail>
<d2p1:ArticleCode>sample string 1</d2p1:ArticleCode>
<d2p1:ArticleDesignation>sample string 2</d2p1:ArticleDesignation>
<d2p1:DiscountPercentage1>5.1</d2p1:DiscountPercentage1>
<d2p1:Quantity>sample string 3</d2p1:Quantity>
<d2p1:UnitaryPriceWithoutTaxesBeforeDiscounts>4.1</d2p1:UnitaryPriceWithoutTaxesBeforeDiscounts>
</d2p1:ArticleDetail>
<d2p1:ArticleDetail>
<d2p1:ArticleCode>sample string 1</d2p1:ArticleCode>
<d2p1:ArticleDesignation>sample string 2</d2p1:ArticleDesignation>
<d2p1:DiscountPercentage1>5.1</d2p1:DiscountPercentage1>
<d2p1:Quantity>sample string 3</d2p1:Quantity>
<d2p1:UnitaryPriceWithoutTaxesBeforeDiscounts>4.1</d2p1:UnitaryPriceWithoutTaxesBeforeDiscounts>
</d2p1:ArticleDetail>
</ArticleDetail>
<DocumentDetail xmlns:d2p1="http://schemas.datacontract.org/2004/07/WinMax4API.Models">
<d2p1:ArticleCode>sample string 8</d2p1:ArticleCode>
<d2p1:ArticleDesignation>sample string 10</d2p1:ArticleDesignation>
<d2p1:Credential>
<d2p1:CompanyCode>sample string 1</d2p1:CompanyCode>
<d2p1:CompanyName>sample string 2</d2p1:CompanyName>
<d2p1:ConnectionString>sample string 9</d2p1:ConnectionString>
<d2p1:DropDate>sample string 5</d2p1:DropDate>
<d2p1:EntityCode>8</d2p1:EntityCode>
<d2p1:PageNumber>7</d2p1:PageNumber>
<d2p1:PhoneNumber>sample string 11</d2p1:PhoneNumber>
<d2p1:TerminalNo>sample string 10</d2p1:TerminalNo>
<d2p1:UserLogin>sample string 3</d2p1:UserLogin>
<d2p1:UserPassword>sample string 4</d2p1:UserPassword>
<d2p1:WebServiceURL>sample string 6</d2p1:WebServiceURL>
</d2p1:Credential>
<d2p1:DocumentId>sample string 7</d2p1:DocumentId>
<d2p1:DocumentTypeCode>sample string 3</d2p1:DocumentTypeCode>
<d2p1:EntityCode>sample string 4</d2p1:EntityCode>
<d2p1:IsExternal>sample string 6</d2p1:IsExternal>
<d2p1:IsPOS>sample string 5</d2p1:IsPOS>
<d2p1:Quantity>9</d2p1:Quantity>
<d2p1:SourceWarehouseCode>sample string 1</d2p1:SourceWarehouseCode>
<d2p1:TargetWarehouseCode>sample string 2</d2p1:TargetWarehouseCode>
</DocumentDetail>
<ShippingTypeCode>sample string 1</ShippingTypeCode>
<credential xmlns:d2p1="http://schemas.datacontract.org/2004/07/WinMax4API.Models">
<d2p1:CompanyCode>sample string 1</d2p1:CompanyCode>
<d2p1:CompanyName>sample string 2</d2p1:CompanyName>
<d2p1:ConnectionString>sample string 9</d2p1:ConnectionString>
<d2p1:DropDate>sample string 5</d2p1:DropDate>
<d2p1:EntityCode>8</d2p1:EntityCode>
<d2p1:PageNumber>7</d2p1:PageNumber>
<d2p1:PhoneNumber>sample string 11</d2p1:PhoneNumber>
<d2p1:TerminalNo>sample string 10</d2p1:TerminalNo>
<d2p1:UserLogin>sample string 3</d2p1:UserLogin>
<d2p1:UserPassword>sample string 4</d2p1:UserPassword>
<d2p1:WebServiceURL>sample string 6</d2p1:WebServiceURL>
</credential>
<stateOfOrder>sample string 2</stateOfOrder>
</CreateDocumentRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |