POST portal/order_complete
Request Information
URI Parameters
None.
Body Parameters
OrderRequestParamModelName | Description | Type | Additional information |
---|---|---|---|
api_key | string |
Required |
|
company | string |
None. |
|
first_name | string |
Required |
|
last_name | string |
Required |
|
string |
Required |
||
phone | string |
None. |
|
address_1 | string |
None. |
|
address_2 | string |
None. |
|
city | string |
None. |
|
state | string |
None. |
|
country | string |
None. |
|
postcode | string |
None. |
|
items | Collection of OrderItem |
None. |
Request Formats
application/json, text/json
Sample:
{ "api_key": "sample string 1", "company": "sample string 2", "first_name": "sample string 3", "last_name": "sample string 4", "email": "sample string 5", "phone": "sample string 6", "address_1": "sample string 7", "address_2": "sample string 8", "city": "sample string 9", "state": "sample string 10", "country": "sample string 11", "postcode": "sample string 12", "items": [ { "sku": 1, "price": 2.0, "quantity": 3 }, { "sku": 1, "price": 2.0, "quantity": 3 } ] }
text/xml
Sample:
<OrderRequestParamModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPI.API.Models.PortalModels"> <address_1>sample string 7</address_1> <address_2>sample string 8</address_2> <api_key>sample string 1</api_key> <city>sample string 9</city> <company>sample string 2</company> <country>sample string 11</country> <email>sample string 5</email> <first_name>sample string 3</first_name> <items> <OrderItem> <price>2</price> <quantity>3</quantity> <sku>1</sku> </OrderItem> <OrderItem> <price>2</price> <quantity>3</quantity> <sku>1</sku> </OrderItem> </items> <last_name>sample string 4</last_name> <phone>sample string 6</phone> <postcode>sample string 12</postcode> <state>sample string 10</state> </OrderRequestParamModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
OrderCompleteResponseName | Description | Type | Additional information |
---|---|---|---|
status | string |
None. |
|
request_length | decimal number |
None. |
|
message | string |
None. |
|
ipaddress | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "status": "sample string 1", "request_length": 2.1, "message": "sample string 3", "ipaddress": "sample string 4" }
text/xml
Sample:
<result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPI.API.Models.PortalModels"> <ipaddress xmlns="http://schemas.datacontract.org/2004/07/TPI.API.Models">sample string 4</ipaddress> <message xmlns="http://schemas.datacontract.org/2004/07/TPI.API.Models">sample string 3</message> <request_length xmlns="http://schemas.datacontract.org/2004/07/TPI.API.Models">2.1</request_length> <status xmlns="http://schemas.datacontract.org/2004/07/TPI.API.Models">sample string 1</status> </result>