Direct API

Shipping Addresses

Retrieve paginated list of shipping addresses

GET
/addresses/shipping

Retrieve a paginated list of shipping addresses with optional pagination parameters. Use 'all=true' to get all addresses without pagination.

Parameters

Name Type Required Description
pagenumberNoPage number for pagination (default: 1)
per_pagenumberNoNumber of addresses per page (options: 15, 50, 100, 200, default: 15)
allbooleanNoReturn all addresses without pagination when set to true (default: false)

Response Codes

Code Status Description
200SuccessShipping addresses retrieved
401UnauthorizedInvalid or missing API key
422Validation ErrorInvalid per_page value. Allowed values are: 15, 50, 100, 200
429Too Many RequestsRate limit exceeded
500Internal Server ErrorServer error occurred

Response Format

Field Type Description
listarrayArray of shipping address objects
list[].idintegerUnique address identifier
list[].address_typestringType of address (individual, business)
list[].country_codestringCountry code (ISO 2-letter)
list[].locality_idintegerLocality identifier
list[].contactstringContact person name
list[].phonestringContact phone number
list[].emailstringContact email address
list[].is_defaultbooleanWhether this is the default shipping address
metaobjectPagination metadata
meta.totalintegerTotal number of addresses
meta.current_pageintegerCurrent page number
meta.per_pageintegerItems per page
meta.last_pageintegerLast page number

Response Example

RESPONSEJSON
{
  "list": [
    {
      "id": 120,
      "address_type": "individual",
      "country_code": "RO",
      "locality_id": 8178,
      "street_id": null,
      "street_name": "Company Street",
      "street_no": "456",
      "street_details": null,
      "zipcode": "077016",
      "contact": "Alex Johnson",
      "phone": "0721234567",
      "email": "alex.johnson@example.com",
      "is_default": true,
      "created_at": "2025-05-29T15:41:57.000000Z",
      "updated_at": "2025-06-23T21:02:17.000000Z",
      "coordinates": {
        "lat": 44.6359645,
        "lng": 26.1156689
      },
      "locality_name": "Dumbraveni (Ilfov)",
      "county_id": 26,
      "county_code": "IF",
      "county_name": "Ilfov"
    },
    {
      "id": 115,
      "address_type": "business",
      "country_code": "RO",
      "locality_id": 13893,
      "street_id": 50235,
      "street_name": "Strada Industriei",
      "street_no": "789",
      "street_details": "Warehouse Building",
      "zipcode": "032067",
      "company_name": "Logistics Corp SRL",
      "contact": "Maria Popescu",
      "phone": "0721234567",
      "email": "maria.popescu@example.com",
      "is_default": false,
      "created_at": "2025-05-19T07:52:23.000000Z",
      "updated_at": "2025-06-23T21:02:17.000000Z",
      "locality_name": "Bucuresti (Sector 3)",
      "county_id": 10,
      "county_code": "B",
      "county_name": "Bucuresti"
    }
  ],
  "meta": {
    "total": 2,
    "per_page": 15,
    "current_page": 1,
    "last_page": 1,
    "from": 1,
    "to": 2
  }
}

Complete API Reference

For interactive testing and additional technical details, visit our complete Swagger documentation.

View in Swagger Documentation