POST api/Sync?orderId={orderId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
orderId

integer

Required

Body Parameters

EntitySyncAddressModel
NameDescriptionTypeAdditional information
Id

integer

None.

OrderNumber

string

None.

Address

string

None.

Name

string

None.

Email

string

None.

PhoneNumber

string

None.

Country

string

None.

State

string

None.

StateCode

string

None.

City

string

None.

Area

string

None.

Zip

string

None.

IsDefault

boolean

None.

BillingAddressId

integer

None.

BillingName

string

None.

BillingPhone

string

None.

BillingEmail

string

None.

BillingAddress

string

None.

BillingArea

string

None.

BillingCountry

string

None.

BillingState

string

None.

BillingCity

string

None.

BillingZip

string

None.

BillingStateCode

string

None.

UseGSTInvoice

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "OrderNumber": "sample string 2",
  "Address": "sample string 3",
  "Name": "sample string 4",
  "Email": "sample string 5",
  "PhoneNumber": "sample string 6",
  "Country": "sample string 7",
  "State": "sample string 8",
  "StateCode": "sample string 9",
  "City": "sample string 10",
  "Area": "sample string 11",
  "Zip": "sample string 12",
  "IsDefault": true,
  "BillingAddressId": 21,
  "BillingName": "sample string 22",
  "BillingPhone": "sample string 23",
  "BillingEmail": "sample string 24",
  "BillingAddress": "sample string 25",
  "BillingArea": "sample string 26",
  "BillingCountry": "sample string 27",
  "BillingState": "sample string 28",
  "BillingCity": "sample string 29",
  "BillingZip": "sample string 30",
  "BillingStateCode": "sample string 31",
  "UseGSTInvoice": true
}

application/xml, text/xml

Sample:
<EntitySyncAddressModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GM.Business.Entity">
  <Address>sample string 3</Address>
  <ApplicationId>18</ApplicationId>
  <Area>sample string 11</Area>
  <BillingAddress>sample string 25</BillingAddress>
  <BillingAddressId>21</BillingAddressId>
  <BillingArea>sample string 26</BillingArea>
  <BillingCity>sample string 29</BillingCity>
  <BillingCountry>sample string 27</BillingCountry>
  <BillingEmail>sample string 24</BillingEmail>
  <BillingName>sample string 22</BillingName>
  <BillingPhone>sample string 23</BillingPhone>
  <BillingState>sample string 28</BillingState>
  <BillingStateCode>sample string 31</BillingStateCode>
  <BillingZip>sample string 30</BillingZip>
  <City>sample string 10</City>
  <Country>sample string 7</Country>
  <CreatedBy>14</CreatedBy>
  <CreatedOn>2026-06-04T00:53:44.1943902+02:00</CreatedOn>
  <Email>sample string 5</Email>
  <Id>1</Id>
  <IsDefault>true</IsDefault>
  <IsSameAsShipping>true</IsSameAsShipping>
  <Name>sample string 4</Name>
  <OrderNumber>sample string 2</OrderNumber>
  <PhoneNumber>sample string 6</PhoneNumber>
  <State>sample string 8</State>
  <StateCode>sample string 9</StateCode>
  <UpdatedBy>16</UpdatedBy>
  <UpdatedOn>2026-06-04T00:53:44.1943902+02:00</UpdatedOn>
  <UseGSTInvoice>true</UseGSTInvoice>
  <UserId>13</UserId>
  <Zip>sample string 12</Zip>
</EntitySyncAddressModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Sample:
1

application/xml, text/xml

Sample:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>