POST api/Order/SetOrder
Request Information
URI Parameters
None.
Body Parameters
SetOrderRequestName | Description | Type | Additional information |
---|---|---|---|
Order | Order |
None. |
|
Token | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Order": { "OrderId": "sample string 1", "StoreId": "sample string 2", "IntegrationOrderCode": "sample string 3", "OrderDate": "2024-04-25T12:45:00.8564506+03:00", "CustomerName": "sample string 5", "InvoiceTitle": "sample string 6", "CustomerEmail": "sample string 7", "TaxNumber": "sample string 8", "TaxAuthority": "sample string 9", "Address": "sample string 10", "Neighborhood": "sample string 11", "District": "sample string 12", "City": "sample string 13", "PostalCode": "sample string 14", "Telephone": "sample string 15", "StoreName": "sample string 16", "MarketplaceId": 17, "MarketplaceName": "sample string 18", "MarketplaceShortName": "sample string 19", "IntegratorProfileId": "sample string 20", "IntegratorProfileName": "sample string 21", "IntegratorCompanyName": "sample string 22", "IntegratorCompanyId": "sample string 23", "TotalAmount": 24.0, "NetTotalAmount": 25.0, "TotalTaxAmount": 26.0, "OrderItems": [ { "OrderItemId": "sample string 1", "IntegrationOrderItemCode": "sample string 2", "IntegrationProductCode": "sample string 3", "MerchantSku": "sample string 4", "OrderItemStatus": "sample string 5", "OrderItemStatusDescription": "sample string 6", "Quantity": 7.0, "Price": 8.0, "CurrencyId": 9, "DeliveryTitle": "sample string 10", "Address": "sample string 11", "Neighborhood": "sample string 12", "District": "sample string 13", "City": "sample string 14", "PostalCode": "sample string 15", "Telephone": "sample string 16", "ShippingCompany": "sample string 17", "ShippingTrackingCode": "sample string 18", "ProductName": "sample string 19", "ProductImage": "sample string 20", "ProductTaxRate": 21.0, "Unread": true, "ProductVariantPhrase": "sample string 23", "Amount": 24.0, "NetAmount": 25.0, "TaxAmount": 26.0, "NetPrice": 27.0, "OrderItemInvoiceTypeId": 28, "OrderItemInvoiceScenarioId": 29, "OrderItemInvoiceStatusId": 30, "OrderItemInvoiceUiid": "sample string 31", "OrderItemInvoiceId": "sample string 32", "OrderItemInvoiceScenario": "sample string 33", "OrderItemInvoiceStatus": "sample string 34", "OrderItemInvoiceType": "sample string 35", "OrderItemInvoiceTime": "2024-04-25T12:45:00.8720856+03:00", "ItemOrder": 37, "OrderItemDiscounts": [ { "OrderItemDiscountId": "sample string 1", "OrderItemId": "fa77d788-8fd2-444c-9a2d-e7e71e291f24", "DiscountType": 3, "Title": "sample string 4", "Percentage": 5.0, "Value": 6.0, "Order": 7 }, { "OrderItemDiscountId": "sample string 1", "OrderItemId": "fa77d788-8fd2-444c-9a2d-e7e71e291f24", "DiscountType": 3, "Title": "sample string 4", "Percentage": 5.0, "Value": 6.0, "Order": 7 } ], "Unit": "sample string 38" }, { "OrderItemId": "sample string 1", "IntegrationOrderItemCode": "sample string 2", "IntegrationProductCode": "sample string 3", "MerchantSku": "sample string 4", "OrderItemStatus": "sample string 5", "OrderItemStatusDescription": "sample string 6", "Quantity": 7.0, "Price": 8.0, "CurrencyId": 9, "DeliveryTitle": "sample string 10", "Address": "sample string 11", "Neighborhood": "sample string 12", "District": "sample string 13", "City": "sample string 14", "PostalCode": "sample string 15", "Telephone": "sample string 16", "ShippingCompany": "sample string 17", "ShippingTrackingCode": "sample string 18", "ProductName": "sample string 19", "ProductImage": "sample string 20", "ProductTaxRate": 21.0, "Unread": true, "ProductVariantPhrase": "sample string 23", "Amount": 24.0, "NetAmount": 25.0, "TaxAmount": 26.0, "NetPrice": 27.0, "OrderItemInvoiceTypeId": 28, "OrderItemInvoiceScenarioId": 29, "OrderItemInvoiceStatusId": 30, "OrderItemInvoiceUiid": "sample string 31", "OrderItemInvoiceId": "sample string 32", "OrderItemInvoiceScenario": "sample string 33", "OrderItemInvoiceStatus": "sample string 34", "OrderItemInvoiceType": "sample string 35", "OrderItemInvoiceTime": "2024-04-25T12:45:00.8720856+03:00", "ItemOrder": 37, "OrderItemDiscounts": [ { "OrderItemDiscountId": "sample string 1", "OrderItemId": "fa77d788-8fd2-444c-9a2d-e7e71e291f24", "DiscountType": 3, "Title": "sample string 4", "Percentage": 5.0, "Value": 6.0, "Order": 7 }, { "OrderItemDiscountId": "sample string 1", "OrderItemId": "fa77d788-8fd2-444c-9a2d-e7e71e291f24", "DiscountType": 3, "Title": "sample string 4", "Percentage": 5.0, "Value": 6.0, "Order": 7 } ], "Unit": "sample string 38" } ], "ErpStatus": 27, "Note": "sample string 28", "OrderSpecs": [ { "OrderSpecId": "sample string 1", "SpecName": "sample string 2", "SpecValue": "sample string 3" }, { "OrderSpecId": "sample string 1", "SpecName": "sample string 2", "SpecValue": "sample string 3" } ], "Token": "sample string 29" }, "Token": "sample string 1" }
application/xml, text/xml
Sample:
<SetOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Order"> <Token xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 1</Token> <Order> <Token xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 29</Token> <Address>sample string 10</Address> <City>sample string 13</City> <CustomerEmail>sample string 7</CustomerEmail> <CustomerName>sample string 5</CustomerName> <District>sample string 12</District> <ErpStatus>27</ErpStatus> <IntegrationOrderCode>sample string 3</IntegrationOrderCode> <IntegratorCompanyId>sample string 23</IntegratorCompanyId> <IntegratorCompanyName>sample string 22</IntegratorCompanyName> <IntegratorProfileId>sample string 20</IntegratorProfileId> <IntegratorProfileName>sample string 21</IntegratorProfileName> <InvoiceTitle>sample string 6</InvoiceTitle> <MarketplaceId>17</MarketplaceId> <MarketplaceName>sample string 18</MarketplaceName> <MarketplaceShortName>sample string 19</MarketplaceShortName> <Neighborhood>sample string 11</Neighborhood> <NetTotalAmount>25</NetTotalAmount> <Note>sample string 28</Note> <OrderDate>2024-04-25T12:45:00.8564506+03:00</OrderDate> <OrderId>sample string 1</OrderId> <OrderItems> <OrderItem> <Address>sample string 11</Address> <Amount>24</Amount> <City>sample string 14</City> <CurrencyId>9</CurrencyId> <DeliveryTitle>sample string 10</DeliveryTitle> <District>sample string 13</District> <IntegrationOrderItemCode>sample string 2</IntegrationOrderItemCode> <IntegrationProductCode>sample string 3</IntegrationProductCode> <ItemOrder>37</ItemOrder> <MerchantSku>sample string 4</MerchantSku> <Neighborhood>sample string 12</Neighborhood> <NetAmount>25</NetAmount> <NetPrice>27</NetPrice> <OrderItemDiscounts> <OrderItemDiscount> <DiscountType>3</DiscountType> <Order>7</Order> <OrderItemDiscountId>sample string 1</OrderItemDiscountId> <OrderItemId>fa77d788-8fd2-444c-9a2d-e7e71e291f24</OrderItemId> <Percentage>5</Percentage> <Title>sample string 4</Title> <Value>6</Value> </OrderItemDiscount> <OrderItemDiscount> <DiscountType>3</DiscountType> <Order>7</Order> <OrderItemDiscountId>sample string 1</OrderItemDiscountId> <OrderItemId>fa77d788-8fd2-444c-9a2d-e7e71e291f24</OrderItemId> <Percentage>5</Percentage> <Title>sample string 4</Title> <Value>6</Value> </OrderItemDiscount> </OrderItemDiscounts> <OrderItemId>sample string 1</OrderItemId> <OrderItemInvoiceId>sample string 32</OrderItemInvoiceId> <OrderItemInvoiceScenario>sample string 33</OrderItemInvoiceScenario> <OrderItemInvoiceScenarioId>29</OrderItemInvoiceScenarioId> <OrderItemInvoiceStatus>sample string 34</OrderItemInvoiceStatus> <OrderItemInvoiceStatusId>30</OrderItemInvoiceStatusId> <OrderItemInvoiceTime>2024-04-25T12:45:00.8720856+03:00</OrderItemInvoiceTime> <OrderItemInvoiceType>sample string 35</OrderItemInvoiceType> <OrderItemInvoiceTypeId>28</OrderItemInvoiceTypeId> <OrderItemInvoiceUiid>sample string 31</OrderItemInvoiceUiid> <OrderItemStatus>sample string 5</OrderItemStatus> <OrderItemStatusDescription>sample string 6</OrderItemStatusDescription> <PostalCode>sample string 15</PostalCode> <Price>8</Price> <ProductImage>sample string 20</ProductImage> <ProductName>sample string 19</ProductName> <ProductTaxRate>21</ProductTaxRate> <ProductVariantPhrase>sample string 23</ProductVariantPhrase> <Quantity>7</Quantity> <ShippingCompany>sample string 17</ShippingCompany> <ShippingTrackingCode>sample string 18</ShippingTrackingCode> <TaxAmount>26</TaxAmount> <Telephone>sample string 16</Telephone> <Unit>sample string 38</Unit> <Unread>true</Unread> </OrderItem> <OrderItem> <Address>sample string 11</Address> <Amount>24</Amount> <City>sample string 14</City> <CurrencyId>9</CurrencyId> <DeliveryTitle>sample string 10</DeliveryTitle> <District>sample string 13</District> <IntegrationOrderItemCode>sample string 2</IntegrationOrderItemCode> <IntegrationProductCode>sample string 3</IntegrationProductCode> <ItemOrder>37</ItemOrder> <MerchantSku>sample string 4</MerchantSku> <Neighborhood>sample string 12</Neighborhood> <NetAmount>25</NetAmount> <NetPrice>27</NetPrice> <OrderItemDiscounts> <OrderItemDiscount> <DiscountType>3</DiscountType> <Order>7</Order> <OrderItemDiscountId>sample string 1</OrderItemDiscountId> <OrderItemId>fa77d788-8fd2-444c-9a2d-e7e71e291f24</OrderItemId> <Percentage>5</Percentage> <Title>sample string 4</Title> <Value>6</Value> </OrderItemDiscount> <OrderItemDiscount> <DiscountType>3</DiscountType> <Order>7</Order> <OrderItemDiscountId>sample string 1</OrderItemDiscountId> <OrderItemId>fa77d788-8fd2-444c-9a2d-e7e71e291f24</OrderItemId> <Percentage>5</Percentage> <Title>sample string 4</Title> <Value>6</Value> </OrderItemDiscount> </OrderItemDiscounts> <OrderItemId>sample string 1</OrderItemId> <OrderItemInvoiceId>sample string 32</OrderItemInvoiceId> <OrderItemInvoiceScenario>sample string 33</OrderItemInvoiceScenario> <OrderItemInvoiceScenarioId>29</OrderItemInvoiceScenarioId> <OrderItemInvoiceStatus>sample string 34</OrderItemInvoiceStatus> <OrderItemInvoiceStatusId>30</OrderItemInvoiceStatusId> <OrderItemInvoiceTime>2024-04-25T12:45:00.8720856+03:00</OrderItemInvoiceTime> <OrderItemInvoiceType>sample string 35</OrderItemInvoiceType> <OrderItemInvoiceTypeId>28</OrderItemInvoiceTypeId> <OrderItemInvoiceUiid>sample string 31</OrderItemInvoiceUiid> <OrderItemStatus>sample string 5</OrderItemStatus> <OrderItemStatusDescription>sample string 6</OrderItemStatusDescription> <PostalCode>sample string 15</PostalCode> <Price>8</Price> <ProductImage>sample string 20</ProductImage> <ProductName>sample string 19</ProductName> <ProductTaxRate>21</ProductTaxRate> <ProductVariantPhrase>sample string 23</ProductVariantPhrase> <Quantity>7</Quantity> <ShippingCompany>sample string 17</ShippingCompany> <ShippingTrackingCode>sample string 18</ShippingTrackingCode> <TaxAmount>26</TaxAmount> <Telephone>sample string 16</Telephone> <Unit>sample string 38</Unit> <Unread>true</Unread> </OrderItem> </OrderItems> <OrderSpecs> <OrderSpec> <OrderSpecId>sample string 1</OrderSpecId> <SpecName>sample string 2</SpecName> <SpecValue>sample string 3</SpecValue> </OrderSpec> <OrderSpec> <OrderSpecId>sample string 1</OrderSpecId> <SpecName>sample string 2</SpecName> <SpecValue>sample string 3</SpecValue> </OrderSpec> </OrderSpecs> <PostalCode>sample string 14</PostalCode> <StoreId>sample string 2</StoreId> <StoreName>sample string 16</StoreName> <TaxAuthority>sample string 9</TaxAuthority> <TaxNumber>sample string 8</TaxNumber> <Telephone>sample string 15</Telephone> <TotalAmount>24</TotalAmount> <TotalTaxAmount>26</TotalTaxAmount> </Order> </SetOrderRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SetOrderResponseName | Description | Type | Additional information |
---|---|---|---|
OrderId | string |
None. |
|
ErrorCode | string |
None. |
|
ErrorMessage | string |
None. |
|
ErrorCategory | string |
None. |
|
Result | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "OrderId": "sample string 1", "ErrorCode": "sample string 2", "ErrorMessage": "sample string 3", "ErrorCategory": "sample string 4", "Result": true }
application/xml, text/xml
Sample:
<SetOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Order"> <ErrorCategory xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 4</ErrorCategory> <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 2</ErrorCode> <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">sample string 3</ErrorMessage> <Result xmlns="http://schemas.datacontract.org/2004/07/Shams.Api.Model.Base">true</Result> <OrderId>sample string 1</OrderId> </SetOrderResponse>