Response [200 Ok]
| Uri | /api/v2/cart!shippingaddress |
|---|---|
| UriDescription | Shipping Address |
| EndpointType | ShippingAddress |
| Locator | ShippingAddress |
| LocatorType | Object |
ShippingAddress [1 of 1]
/api/v2/cart!shippingaddress
| Uri | /api/v2/cart!shippingaddress |
|---|---|
| UriDescription | Shipping Address |
| City | empty string |
| Country | empty string |
| FirstName | empty string |
| LastName | empty string |
| Phone | empty string |
| State | empty string |
| Street1 | empty string |
| Street2 | empty string |
| Zip | empty string |
Request
| Uri | /api/v2/cart!shippingaddress |
|---|---|
| Method | GET |
| Version | v2 |
Config
{
"expand_method": "ref",
"shorturis": false
}
Options
Methods
OPTIONS
| Permissions |
|
|---|
GET
| Permissions |
|
|---|
POST
| Permissions |
|
|---|
DELETE
| Permissions |
|
|---|
Output Fields
| City | text | |
|---|---|---|
| Country | text | |
| FirstName | text | |
| LastName | text | |
| Phone | text | |
| State | text | |
| Street1 | text | |
| Street2 | text | |
| Zip | text |
JSON
{
"Request": {
"Version": "v2",
"Method": "GET",
"Uri": "/api/v2/cart!shippingaddress"
},
"Options": {
"MethodDetails": {
"OPTIONS": {
"Permissions": [
"Read"
]
},
"GET": {
"Permissions": [
"Read"
]
},
"POST": {
"Permissions": [
"Modify"
]
},
"DELETE": {
"Permissions": [
"Modify"
]
}
},
"Methods": [
"OPTIONS",
"GET",
"POST",
"DELETE"
],
"ParameterDescription": {
"Varchar": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)",
"PhoneNumber": "U.S. phone numbers.",
"Uri": "Absolute or relative URL, restricted to Locator(s) of the supplied URL if not null. Up to a MAX_LENGTH in length.",
"Boolean": "For true return type true or 1, for false type false or 0"
},
"Parameters": {
"POST": [
{
"Name": "FirstName",
"Required": true,
"ReadOnly": false,
"Default": null,
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 50
},
{
"Name": "LastName",
"Required": true,
"ReadOnly": false,
"Default": null,
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 50
},
{
"Name": "Phone",
"Required": true,
"ReadOnly": false,
"Default": null,
"Type": "PhoneNumber"
},
{
"Name": "AddressUri",
"Required": false,
"ReadOnly": false,
"Default": null,
"Description": "Required if UseAddressOnAccount is false. Optional/Ignored otherwise",
"Type": "Uri",
"MAX_LENGTH": "INFINITY",
"Locator": [
"Address"
]
},
{
"Name": "UseAddressOnAccount",
"Required": false,
"ReadOnly": false,
"Default": false,
"Description": "Use logged in users address on file. If true AddressUri is optional/ignored",
"Type": "Boolean"
}
],
"DELETE": []
},
"MediaTypes": [
"application/json",
"application/vnd.php.serialized",
"application/x-msgpack",
"text/html",
"text/csv"
],
"Output": [
{
"Name": "FirstName",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 50
},
{
"Name": "LastName",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 50
},
{
"Name": "Phone",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 15
},
{
"Name": "Street1",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 40
},
{
"Name": "Street2",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 40
},
{
"Name": "City",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 25
},
{
"Name": "State",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 20
},
{
"Name": "Zip",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 10
},
{
"Name": "Country",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 20
}
]
},
"Response": {
"Uri": "/api/v2/cart!shippingaddress",
"Locator": "ShippingAddress",
"LocatorType": "Object",
"ShippingAddress": {
"FirstName": "",
"LastName": "",
"Phone": "",
"Street1": "",
"Street2": "",
"City": "",
"Zip": "",
"State": "",
"Country": "",
"Uri": "/api/v2/cart!shippingaddress",
"UriDescription": "Shipping Address"
},
"UriDescription": "Shipping Address",
"EndpointType": "ShippingAddress",
"Timing": {
"Total": {
"time": 0.03002,
"cycles": 1,
"objects": 0
}
}
},
"Code": 200,
"Message": "Ok"
}