Skip to content

Addresses

Use this endpoint to obtain details on Adaptix's company addresses.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
<?php
use Adaptix\AdaptixApi;
use Adaptix\Auth\ApiAuth;

// ...
$initAuth    = new ApiAuth();
$auth        = $initAuth->newAuth($settings);
$apiUrl      = "https://your-adaptix.ai";
$api         = new AdaptixApi();
$addressApi = $api->newApi("addresses", $auth, $apiUrl);

Get Address

1
2
3
4
<?php

//...
$address = $addressApi->get($id);

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{  
  "address":{  
    "id":1,
    "company_name":"test company",
    "address":"address1",
    "address2":"",
    "city":"California",
    "state":"CA",
    "zip": "95014",
    "country": "United States",
    "is_default": false,
  }
}
Get an individual address by ID.

HTTP Request

GET /addresses/ID

Response

Expected Response Code: 200

See JSON code example.

Address Properties

Name Type Description
id int ID of the address
company_name string The company name
address string address of the company
address2 string address line 2 of the company
city string Company city
state string Company state
zip string Company zip
country string Company country
is_default boolean Whether the address is the default address

List Company Address

1
2
3
4
<?php

//...
$addresses = $addressApi->getList($searchFilter, $start, $limit, $orderBy, $orderByDir);

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{  
  "total":8,
  "addresses":[  
    {  
      "id":1,
      "company_name":"test company",
      "address":"address1",
      "address2":"",
      "city":"California",
      "state":"CA",
      "zip": "95014",
      "country": "United States",
      "is_default": false,
    },
    [...]
  ]
}
Returns a list of company address. This list is not filterable.

HTTP Request

GET /addresses

Response

Expected Response Code: 200

See JSON code example.

Address Properties

Name Type Description
id int ID of the address
company_name string The company name
address string address of the company
address2 string address line 2 of the company
city string Company city
state string Company state
zip string Company zip
country string Company country
is_default boolean Whether the address is the default address

Create Address

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<?php 

$data = array(
    'country' => 'United States',
    'company_name' => 'test company',
    'address' => 'address',
    'address2' => 'address2',
    'city' => 'California',
    'state' => 'CA',
    'zip' => '95014',
    'is_default' => false,
);

$address = $addressApi->create($data);
Create a new address.

HTTP Request

POST /addresses/new

Post Parameters

Name Type Description
company_name string The company name
address string address of the company
address2 string address line 2 of the company
city string Company city
state string Company state
zip string Company zip
country string Company country
is_default boolean Whether the address is the default address

Response

Expected Response Code: 201

Properties

Same as Get Address.

Edit Address

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
<?php

$id   = 1;
$data = array(
    'company_name' => 'test company 2',
    'address' => 'new address',
    'address2' => ''
);

$address = $addressApi->edit($id, $data);
Edit a new address.

PATCH fails if the address with the given ID does not exist and updates the address field values with the values form the request.

HTTP Request

To edit an address and return a 404 if the address is not found:

PATCH /addresses/ID/edit

Post Parameters

Name Type Description
company_name string The company name
address string address of the company
address2 string address line 2 of the company
city string Company city
state string Company state
zip string Company zip
country string Company country
is_default boolean Whether the address is the default address

Response

If PATCH, the expected response code is 200.

Properties

Same as Get Address.

Delete Address

1
2
3
<?php

$address = $addressApi->delete($id);
Delete an address.

HTTP Request

DELETE /addresses/ID/delete

Response

Expected Response Code: 200

Properties

Same as Get Address.