GET api/Customer?cid={cid}&contractID={contractID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| cid | integer |
Required |
|
| contractID | integer |
Default value is -1 |
Body Parameters
None.
Response Information
Resource Description
Customer| Name | Description | Type | Additional information |
|---|---|---|---|
| btxId | integer |
None. |
|
| createdShipToId | integer |
None. |
|
| company | string |
None. |
|
| firstname | string |
None. |
|
| lastname | string |
None. |
|
| acctitle | string |
None. |
|
| accphone | string |
None. |
|
| street_1 | string |
None. |
|
| street_2 | string |
None. |
|
| telephone | string |
None. |
|
| country | string |
None. |
|
| region | string |
None. |
|
| city | string |
None. |
|
| zip | string |
None. |
|
| string |
None. |
||
| terms_id | string |
None. |
|
| p1 | string |
None. |
|
| p2 | string |
None. |
|
| p3 | string |
None. |
|
| addShip2 | integer |
None. |
|
| addContact | integer |
None. |
|
| Status | string |
None. |
|
| ErrorMessage | string |
None. |
|
| Ship2s | Collection of Ship2Address |
None. |
Response Formats
application/json, text/json
Sample:
{
"btxId": 1,
"createdShipToId": 2,
"company": "sample string 3",
"firstname": "sample string 4",
"lastname": "sample string 5",
"acctitle": "sample string 6",
"accphone": "sample string 7",
"street_1": "sample string 8",
"street_2": "sample string 9",
"telephone": "sample string 10",
"country": "sample string 11",
"region": "sample string 12",
"city": "sample string 13",
"zip": "sample string 14",
"email": "sample string 15",
"terms_id": "sample string 16",
"p1": "sample string 17",
"p2": "sample string 18",
"p3": "sample string 19",
"addShip2": 20,
"addContact": 21,
"Status": "sample string 22",
"ErrorMessage": "sample string 23",
"Ship2s": [
{
"ship2id": 1,
"btxId": 2,
"company": "sample string 3",
"street_1": "sample string 4",
"street_2": "sample string 5",
"telephone": "sample string 6",
"country": "sample string 7",
"region": "sample string 8",
"city": "sample string 9",
"zip": "sample string 10"
},
{
"ship2id": 1,
"btxId": 2,
"company": "sample string 3",
"street_1": "sample string 4",
"street_2": "sample string 5",
"telephone": "sample string 6",
"country": "sample string 7",
"region": "sample string 8",
"city": "sample string 9",
"zip": "sample string 10"
}
]
}
application/xml, text/xml
Sample:
<Customer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ADIGlobal.MagentoAPI.Models">
<ErrorMessage>sample string 23</ErrorMessage>
<Ship2s>
<Ship2Address>
<btxId>2</btxId>
<city>sample string 9</city>
<company>sample string 3</company>
<country>sample string 7</country>
<region>sample string 8</region>
<ship2id>1</ship2id>
<street_1>sample string 4</street_1>
<street_2>sample string 5</street_2>
<telephone>sample string 6</telephone>
<zip>sample string 10</zip>
</Ship2Address>
<Ship2Address>
<btxId>2</btxId>
<city>sample string 9</city>
<company>sample string 3</company>
<country>sample string 7</country>
<region>sample string 8</region>
<ship2id>1</ship2id>
<street_1>sample string 4</street_1>
<street_2>sample string 5</street_2>
<telephone>sample string 6</telephone>
<zip>sample string 10</zip>
</Ship2Address>
</Ship2s>
<Status>sample string 22</Status>
<accphone>sample string 7</accphone>
<acctitle>sample string 6</acctitle>
<addContact>21</addContact>
<addShip2>20</addShip2>
<btxId>1</btxId>
<city>sample string 13</city>
<company>sample string 3</company>
<country>sample string 11</country>
<createdShipToId>2</createdShipToId>
<email>sample string 15</email>
<firstname>sample string 4</firstname>
<lastname>sample string 5</lastname>
<p1>sample string 17</p1>
<p2>sample string 18</p2>
<p3>sample string 19</p3>
<region>sample string 12</region>
<street_1>sample string 8</street_1>
<street_2>sample string 9</street_2>
<telephone>sample string 10</telephone>
<terms_id>sample string 16</terms_id>
<zip>sample string 14</zip>
</Customer>