Get shipping address

This API returns the delivery address for the requested order ID

GET https://order.gelatoapis.com/v3/orders/{{orderId}}/shipping-address

Request example:

$ curl -X GET \
   https://order.gelatoapis.com/v3/orders/e575556f-1daa-46dd-a4cc-84bcfc0a4f36/shipping-address \
   -H 'X-API-KEY: {{apiKey}}'

Response example:

{
    "id": "d6bcf17f-3a48-4ec8-888e-70766ae8b56a",
    "country": "US",
    "firstName": "Paul",
    "lastName": "Smith",
    "companyName": "Example",
    "addressLine1": "451 Clarkson Ave",
    "addressLine2": "Brooklyn",
    "city": "New York",
    "postСode": "11203",
    "state": "NY",
    "email": "[email protected]",
    "phone": "123456789",
    "isBusiness": false
}

Request

Parameter	Type	Description
orderId (required)	string	Gelato order id.

Response Parameters

Parameter	Type	Description
id (required)	string	Shipment address id
country (required)	string	The two-character ISO 3166-1 code that identifies the country or region.
firstName (required)	string	The first name of the recipient at this address.
lastName (required)	string	The last name of the recipient at this address.
companyName (optional)	string	The company name of the recipient at this address.
addressLine1 (required)	string	The first line of the address. For example, number, street, and so on.
addressLine2 (optional)	string	The second line of the address. For example, suite or apartment number.
city (required)	string	The city name.
postСode (required)	string	The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
state (optional)	string	The code for a US state or the equivalent for other countries.
email (required)	string	The email address for the recipient.
phone (optional)	string	The phone number, in E.123 format.
isBusiness (optional)	bool	Boolean value, declares the recipient being a business.
federalTaxId (optional)	string	The Federal Tax identification number of recipient.
stateTaxId (optional)	string	The State Tax identification number of recipient.
registrationStateCode (optional)	string	The code number for a US state or the equivalent for other countries that defines state where recipient company is registered.

Response Messages

Error response example:

{
  "message": "Order not found."
}

HTTP Status Code	Message
404	Order not found.

---