POST api/order/Order/{orderID}/Post?postOnlyIfBalanceIsZero={postOnlyIfBalanceIsZero}

This API method will allow you to Post an UnOfficial order

Request Information

URI Parameters

NameDescriptionTypeAdditional information
orderID

Order # of the order to Post

 integer

Required
postOnlyIfBalanceIsZero

When true (default), the order is only posted if its payments cover the order total. Pass false to post an order that still has a balance due (e.g. advanced return orders). Mirrors the SOAP SetStatusPosted behavior. Honored only for trusted API integrations (Basic / ByDesignXHeader); Rep/Customer bearer-token callers are always forced to true.

 boolean

Default value is True

Body Parameters

None.

Request Formats

application/xml

Sample:

An exception has occurred while using the formatter 'XmlFormatter' to generate sample for media type 'application/xml'. Exception message: An object of type 'String' cannot be used with a type parameter of 'Int32'. Parameter name: value

text/xml

Sample:

An exception has occurred while using the formatter 'XmlFormatter' to generate sample for media type 'text/xml'. Exception message: An object of type 'String' cannot be used with a type parameter of 'Int32'. Parameter name: value

application/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: An object of type 'String' cannot be used with a type parameter of 'Int32'. Parameter name: value

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: An object of type 'String' cannot be used with a type parameter of 'Int32'. Parameter name: value

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'Int32'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/xml, text/xml, application/json, text/json

Sample:

Sample not available.