Provide the authorized or anonymous token for a shopper.
expandstringOptional
Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.
fieldsstringOptional
Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.
Responses
200
Successful response.
application/json
401
Invalid Token
application/json
get
/v1/shoppers/me/carts/active/shipping-address
Add or update cart shipping address
put
Updates the shipping address for a cart.
Query parameters
tokenstringOptional
Provide the authorized or anonymous token for a shopper.
expandstringOptional
Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.
fieldsstringOptional
Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.
Body
Responses
204
No content.
401
Invalid Token
application/json
409
Invalid Shipping Country
Restricted Shipping Country
Payment Unexpected Error
invalid-state-code
invalid-postal-code
application/json
put
/v1/shoppers/me/carts/active/shipping-address
No content
Apply shipping address to cart
post
Applies a postal code to a shipping address in the cart. Note: Applying the the postal code to the shipping address will trigger applicable tax calculations for the cart.
Query parameters
tokenstringOptional
Provide the authorized or anonymous token for a shopper.
countrystringOptional
Two digit country code (ISO 3166-2). See data.okfn.or/data/core/country-list for a complete list of country codes.
postalCodestringOptional
Provide a country-specific length and format postal code to apply to the shipping address. When used, the postalCode also retrieves the city and state information required to support tax estimation for a cart.
suggestionIdstringOptional
Provide the identifier of a Shipping Address Suggestion resource to apply to the cart's shipping address.
expandstringOptional
Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.
fieldsstringOptional
Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.
Get the shipping address for an order. You must specify the ID of the order in the {id} URI path parameter.
Path parameters
orderIdstringRequired
Provide the order's identifier.
Query parameters
tokenstringOptional
Provide the authorized or anonymous token for a shopper.
expandstringOptional
Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.
fieldsstringOptional
Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.
