POST api/Sync?invoiceId={invoiceId}&appId={appId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
invoiceId

integer

Required

appId

integer

Required

Body Parameters

EntityUserOrderModel
NameDescriptionTypeAdditional information
Id

integer

None.

Amount

integer

None.

AddressId

integer

None.

OrdersId

string

None.

Discount

decimal number

None.

DiscountAmount

decimal number

None.

OrderStatus

integer

None.

OrderStatusName

string

None.

CodCharge

decimal number

None.

ShippingType

integer

None.

TrackingId

string

None.

TrackingUrl

string

None.

DeliveryServiceName

string

None.

UpdatedDtm

date

None.

DeliveryCharge

decimal number

None.

InvoiceStatus

integer

None.

GatewayId

integer

None.

OrderType

integer

None.

PaymentMethod

string

None.

ApplicationName

string

None.

ApplicationId

integer

None.

ApplicationRelativeUrl

string

None.

Remark

string

None.

CancelRequest

boolean

None.

RefundRequest

boolean

None.

OrderedOn

date

None.

DeliveredOn

date

None.

DispatchedOn

date

None.

OrderDetails

Collection of EntityUserOrderDetailModel

None.

ShippingAddress

EntityUserShippingAddressModel

None.

Delivery

EntityUserOrderDeliveryModel

None.

UserId

integer

None.

FirstName

string

None.

Email

string

None.

Phone

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Amount": 2,
  "AddressId": 3,
  "OrdersId": "sample string 4",
  "Discount": 1.1,
  "DiscountAmount": 1.1,
  "OrderStatus": 1,
  "OrderStatusName": "Cart",
  "CodCharge": 1.1,
  "ShippingType": 1,
  "TrackingId": "sample string 5",
  "TrackingUrl": "sample string 6",
  "DeliveryServiceName": "sample string 7",
  "UpdatedDtm": "2026-07-22T12:27:14.8371113-07:00",
  "DeliveryCharge": 1.1,
  "InvoiceStatus": 1,
  "GatewayId": 1,
  "OrderType": 8,
  "PaymentMethod": "sample string 9",
  "ApplicationName": "sample string 10",
  "ApplicationId": 11,
  "ApplicationRelativeUrl": "sample string 12",
  "Remark": "sample string 13",
  "CancelRequest": true,
  "RefundRequest": true,
  "OrderedOn": "2026-07-22T12:27:14.8371113-07:00",
  "DeliveredOn": "2026-07-22T12:27:14.8371113-07:00",
  "DispatchedOn": "2026-07-22T12:27:14.8371113-07:00",
  "OrderDetails": [
    {
      "Id": 1,
      "OrderId": 2,
      "ProductId": 3,
      "ApplicationId": 4,
      "ProductName": "sample string 5",
      "ProductCaption": "sample string 6",
      "RelativePageUrl": "sample string 7",
      "UnitPrice": 1.1,
      "TotalPrice": 1.1,
      "Quantity": 1,
      "DeliveryCharge": 1.1,
      "Remark": "sample string 8",
      "ImageUrl": null,
      "IsComplementary": true,
      "ComplementaryReason": "sample string 10",
      "OrderStatus": 11,
      "KOTNumber": 12,
      "TableId": 13,
      "TableNumber": "sample string 14",
      "SectionName": "sample string 15",
      "KOTStatus": 16,
      "KOTDtm": "2026-07-22T12:27:14.8371113-07:00",
      "StockId": 1
    },
    {
      "Id": 1,
      "OrderId": 2,
      "ProductId": 3,
      "ApplicationId": 4,
      "ProductName": "sample string 5",
      "ProductCaption": "sample string 6",
      "RelativePageUrl": "sample string 7",
      "UnitPrice": 1.1,
      "TotalPrice": 1.1,
      "Quantity": 1,
      "DeliveryCharge": 1.1,
      "Remark": "sample string 8",
      "ImageUrl": null,
      "IsComplementary": true,
      "ComplementaryReason": "sample string 10",
      "OrderStatus": 11,
      "KOTNumber": 12,
      "TableId": 13,
      "TableNumber": "sample string 14",
      "SectionName": "sample string 15",
      "KOTStatus": 16,
      "KOTDtm": "2026-07-22T12:27:14.8371113-07:00",
      "StockId": 1
    }
  ],
  "ShippingAddress": {
    "Id": 1,
    "Address": "sample string 2",
    "Name": "sample string 3",
    "PhoneNumber": "sample string 4",
    "Email": "sample string 5",
    "Country": "sample string 6",
    "State": "sample string 7",
    "City": "sample string 8",
    "Area": "sample string 9",
    "Zip": "sample string 10",
    "UserId": 11,
    "CreatedBy": 12,
    "CreatedOn": "2026-07-22T12:27:14.8371113-07:00",
    "UpdatedBy": 14,
    "UpdatedOn": "2026-07-22T12:27:14.8371113-07:00",
    "ApplicationId": 16,
    "IsDefault": true
  },
  "Delivery": {
    "Id": 1,
    "DeliveryPeriod": 2,
    "ExpectedDay": 3,
    "Date": "2026-07-22T22:27:14.8683412Z",
    "Time": "3 hours"
  },
  "UserId": 16,
  "FirstName": "sample string 17",
  "Email": "sample string 18",
  "Phone": "sample string 19"
}

application/xml, text/xml

Sample:
<EntityUserOrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GM.Business.Entity">
  <AddressId>3</AddressId>
  <Amount>2</Amount>
  <ApplicationId>11</ApplicationId>
  <ApplicationName>sample string 10</ApplicationName>
  <ApplicationRelativeUrl>sample string 12</ApplicationRelativeUrl>
  <CancelRequest>true</CancelRequest>
  <CodCharge>1.1</CodCharge>
  <DeliveredOn>2026-07-22T12:27:14.8371113-07:00</DeliveredOn>
  <Delivery>
    <DeliveryPeriod>2</DeliveryPeriod>
    <ExpectedDay>3</ExpectedDay>
    <Id>1</Id>
  </Delivery>
  <DeliveryCharge>1.1</DeliveryCharge>
  <DeliveryServiceName>sample string 7</DeliveryServiceName>
  <Discount>1.1</Discount>
  <DiscountAmount>1.1</DiscountAmount>
  <DispatchedOn>2026-07-22T12:27:14.8371113-07:00</DispatchedOn>
  <Email>sample string 18</Email>
  <FirstName>sample string 17</FirstName>
  <GatewayId>1</GatewayId>
  <Id>1</Id>
  <InvoiceStatus>1</InvoiceStatus>
  <OrderDetails>
    <EntityUserOrderDetailModel>
      <ApplicationId>4</ApplicationId>
      <ComplementaryReason>sample string 10</ComplementaryReason>
      <DeliveryCharge>1.1</DeliveryCharge>
      <Id>1</Id>
      <IsComplementary>true</IsComplementary>
      <KOTDtm>2026-07-22T12:27:14.8371113-07:00</KOTDtm>
      <KOTNumber>12</KOTNumber>
      <KOTStatus>16</KOTStatus>
      <OrderId>2</OrderId>
      <OrderStatus>11</OrderStatus>
      <ProductCaption>sample string 6</ProductCaption>
      <ProductId>3</ProductId>
      <ProductName>sample string 5</ProductName>
      <Quantity>1</Quantity>
      <RelativePageUrl>sample string 7</RelativePageUrl>
      <Remark>sample string 8</Remark>
      <SectionName>sample string 15</SectionName>
      <StockId>1</StockId>
      <TableId>13</TableId>
      <TableNumber>sample string 14</TableNumber>
      <TotalPrice>1.1</TotalPrice>
      <UnitPrice>1.1</UnitPrice>
    </EntityUserOrderDetailModel>
    <EntityUserOrderDetailModel>
      <ApplicationId>4</ApplicationId>
      <ComplementaryReason>sample string 10</ComplementaryReason>
      <DeliveryCharge>1.1</DeliveryCharge>
      <Id>1</Id>
      <IsComplementary>true</IsComplementary>
      <KOTDtm>2026-07-22T12:27:14.8371113-07:00</KOTDtm>
      <KOTNumber>12</KOTNumber>
      <KOTStatus>16</KOTStatus>
      <OrderId>2</OrderId>
      <OrderStatus>11</OrderStatus>
      <ProductCaption>sample string 6</ProductCaption>
      <ProductId>3</ProductId>
      <ProductName>sample string 5</ProductName>
      <Quantity>1</Quantity>
      <RelativePageUrl>sample string 7</RelativePageUrl>
      <Remark>sample string 8</Remark>
      <SectionName>sample string 15</SectionName>
      <StockId>1</StockId>
      <TableId>13</TableId>
      <TableNumber>sample string 14</TableNumber>
      <TotalPrice>1.1</TotalPrice>
      <UnitPrice>1.1</UnitPrice>
    </EntityUserOrderDetailModel>
  </OrderDetails>
  <OrderStatus>1</OrderStatus>
  <OrderType>8</OrderType>
  <OrderedOn>2026-07-22T12:27:14.8371113-07:00</OrderedOn>
  <OrdersId>sample string 4</OrdersId>
  <PaymentMethod>sample string 9</PaymentMethod>
  <Phone>sample string 19</Phone>
  <RefundRequest>true</RefundRequest>
  <Remark>sample string 13</Remark>
  <ShippingAddress>
    <Address>sample string 2</Address>
    <ApplicationId>16</ApplicationId>
    <Area>sample string 9</Area>
    <City>sample string 8</City>
    <Country>sample string 6</Country>
    <CreatedBy>12</CreatedBy>
    <CreatedOn>2026-07-22T12:27:14.8371113-07:00</CreatedOn>
    <Email>sample string 5</Email>
    <Id>1</Id>
    <IsDefault>true</IsDefault>
    <Name>sample string 3</Name>
    <PhoneNumber>sample string 4</PhoneNumber>
    <State>sample string 7</State>
    <UpdatedBy>14</UpdatedBy>
    <UpdatedOn>2026-07-22T12:27:14.8371113-07:00</UpdatedOn>
    <UserId>11</UserId>
    <Zip>sample string 10</Zip>
  </ShippingAddress>
  <ShippingType>1</ShippingType>
  <TrackingId>sample string 5</TrackingId>
  <TrackingUrl>sample string 6</TrackingUrl>
  <UpdatedDtm>2026-07-22T12:27:14.8371113-07:00</UpdatedDtm>
  <UserId>16</UserId>
</EntityUserOrderModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.