Skip to main content

Introduction

Shipping Addresses specify the delivery destinations associated with an order, including recipient details and location information required for logistics. The id of a shipping address must be provided when creating an order, as this helps to calculate the shipping cost of the order, as well as provide a delivery location.

ENDPOINTS
     GET   /v1/shipping-addresses
     POST   /v1/shipping-addresses
     PUT   /v1/shipping-addresses/:id
     DELETE   /v1/shipping-addresses/:id

Shipping Address Object

Core Parameters


id
A unique identifier randomly generated by our system. Follows the UUID v4 standard.


apartmentNumber
Their apartment number.


addressLine1
Their address line. For example, "101, Where I live avenue"


state
Their state. For example, "California".


country
The ISO 3166-1 Alpha-2 code of their country. For example, "US".


city
Their city. For example, "Los Angeles County".


postalCode
Their postal code.