POST api/orders/finalize

Finalize order as cash or as deliverynote.

Request Information

URI Parameters

None.

Body Parameters

FinalizeOrderRequest
NameDescriptionTypeAdditional information
OrderId

integer

None.
BranchId

integer

None.
PointOfSaleId

integer

None.
CloseOrderType

CloseOrderType

None.
CreditCardAmount

decimal number

None.
CashAmount

decimal number

None.
RoundingAmount

decimal number

None.
ElectronicPaymentsAmount

decimal number

None.
PaymentCardTypeId

integer

None.

Remarks

See FinalizeOrderErrorCode in FinalizeOrderResponse.FinalizeOrderError for error codes.

Example

//Finalize the order with id 1 on branch 75
http://localhost/api/orders/finalize/1/75

Request Formats

application/json, text/json

Sample: 
{
  "OrderId": 1,
  "BranchId": 2,
  "PointOfSaleId": 1,
  "CloseOrderType": 1,
  "CreditCardAmount": 3.0,
  "CashAmount": 4.0,
  "RoundingAmount": 5.0,
  "ElectronicPaymentsAmount": 6.0,
  "PaymentCardTypeId": 1
}

application/xml, text/xml

Sample: 
<FinalizeOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Order">
  <BranchId>2</BranchId>
  <CashAmount>4</CashAmount>
  <CloseOrderType>DeliveryNote</CloseOrderType>
  <CreditCardAmount>3</CreditCardAmount>
  <ElectronicPaymentsAmount>6</ElectronicPaymentsAmount>
  <OrderId>1</OrderId>
  <PaymentCardTypeId>1</PaymentCardTypeId>
  <PointOfSaleId>1</PointOfSaleId>
  <RoundingAmount>5</RoundingAmount>
</FinalizeOrderRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns a FinalizeOrderResponse.

FinalizeOrderResponse
NameDescriptionTypeAdditional information
Success

boolean

None.
Errors

Collection of FinalizeOrderError

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Errors": [
    {
      "ErrorCode": 1,
      "ErrorMessage": "sample string 1"
    },
    {
      "ErrorCode": 1,
      "ErrorMessage": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample: 
<FinalizeOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Order">
  <Errors>
    <FinalizeOrderError>
      <ErrorCode>OrderNotFound</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </FinalizeOrderError>
    <FinalizeOrderError>
      <ErrorCode>OrderNotFound</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </FinalizeOrderError>
  </Errors>
  <Success>true</Success>
</FinalizeOrderResponse>