Retrieve guest billing address by Profile ID
get
/spms/v2/ships/{shipId}/profile/{profileId}/addresses/billing
This is to retrieve a guest billing address
Request
Supported Media Types
- application/json
Path Parameters
-
profileId: integer
Profile ID
-
shipId: number
Ship Id
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Profile Billing Address
Type:
object
Title:
Profile Billing Address
Profile Billing Address
Show Source
-
billingId(optional):
number
Billing IDExample:
11
-
city(optional):
string
Minimum Length:
1
Maximum Length:30
City * `null` if emptyExample:Los Angeles
-
contactName1(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
Contact Person Name 1 * `null` if emptyExample:Amelia
-
contactName2(optional):
string
Minimum Length:
1
Maximum Length:40
Pattern:^[a-zA-Z??-????-????-??0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
Contact Person Name 2 * `null` if emptyExample:Albert
-
country(optional):
object country
Country
-
profileId(optional):
integer
Minimum Value:
1
Pattern:^[0-9]*$
Profile IDExample:1001
-
state(optional):
object state
State
-
street(optional):
string
Minimum Length:
1
Maximum Length:100
Street * `null` if emptyExample:Edwards Street
-
zipCode(optional):
string
Minimum Length:
1
Maximum Length:10
Zip Code * `null` if emptyExample:48075
Nested Schema : country
Type:
object
Country
Show Source
-
code(optional):
string
Minimum Length:
1
Maximum Length:6
Country Code * `null` if emptyExample:US
-
description(optional):
string
Country Name * `null` if emptyExample:
United States
Nested Schema : state
Type:
object
State
Show Source
-
code(optional):
string
Minimum Length:
1
Maximum Length:3
State Code * `null` if emptyExample:CA
-
description(optional):
string
Minimum Length:
1
Maximum Length:49
State Name * `null` if emptyExample:California
400 Response
Bad Request
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Bad Request",
"detail":"The parameter 'profileId' has incorrect format"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
401 Response
Unauthorized
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
"title":"Unauthorized",
"detail":"Valid token is required to access this resource"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
403 Response
Forbidden
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
"title":"Forbidden",
"detail":"Access to this resource is forbidden"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
404 Response
Not Found
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
"title":"Not Found",
"detail":"Ship 186000000404 was not found"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
405 Response
Method Not Allowed
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
"title":"Method Not Supported",
"detail":"HTTP method not supported for this resource"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
406 Response
Not Acceptable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
"title":"Not Acceptable",
"detail":"Request a Mime type that is supported for this Resource"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
410 Response
Gone
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11",
"title":"Gone",
"detail":"Requested Resource no longer exists"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
415 Response
Unsupported Media Type
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
"title":"Invalid content",
"detail":"Content type not supported"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
500 Response
Internal Server Error
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
"title":"Internal Server Error",
"detail":"Issue fulfilling request. Please retry or contact support"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
501 Response
Not Implemented
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2",
"title":"Not implemented",
"detail":"Resource is not implemented in this version of the API"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
503 Response
Service Unavailable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
"title":"Service Unavailable",
"detail":"Service not available"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source