ShopCompany
This endpoint returns company details, for example the company owner, contact details and bank details.
Example Object
{
"shopCompany": {
"name": "api-test-shop",
"owner": null,
"cocNumber": "",
"cocLocation": null,
"vatNumber": "123456789",
"nationalId": "123456789",
"phone": "555-555-5555",
"email": "[email protected]",
"fax": "555-555-5555",
"street": "123 Street St.",
"street2": "Suite 123",
"zipcode": "10001",
"city": "New York",
"region": "New York",
"country": {
"id": 226,
"code": "us",
"code3": "usa",
"title": "United States"
},
"bankName": "The Bank",
"bankAccountHolder": "",
"bankAccountNumber": "",
"bankLocation": "new york",
"bankCode": "123456789",
"bankIban": "123456789",
"bankSwift": "123456789"
}
}
Properties
| name | The company name. {“name”: “api-test-shop”} |
| owner | The company owner. {“owner”: “” } |
| cocNumber | The Chamber of Commerce (CoC) number of the company. {“cocNumber”:””} |
| cocLocation | The CoC location of the company. {“cocLocation”: “”} |
| vatNumber | The VAT number of the company. {“vatNumber”: “123456789”} |
| nationalId | The national identification number. {“nationalId”:123456789} |
| The email address of the shop. {“email”: “[email protected]”} | |
| phone | The phone number of the shop. {“phone”: “555-555-5555”} |
| fax | The fax number of the shop. {“fax”: “555-555-5555”} |
| street | The address of the shop. {“street”: “123 Street St.”} |
| street2 | The address of the shop. {“street2”: “Suite 123”} |
| zipcode | The zipcode of the shop. {“zipcode”: “10001”} |
| city | The city of the shop. {“city”: “New York “} |
| region | The region of the shop. {“region”: “New York”} |
| country | The country object. { “country”: { “id”: 226, “code”: “us”, “code3”: “usa”, “title”: “United States” }} |
| bankName | The bank name. {“bankName”: “The Bank”} |
| bankAccountHolder | The accountholder name. {“bankAccountHolder”: “J”} |
| bankAccountNumber | The account number. {“bankAccountNumber”:””} |
| bankLocation | The location of the bamk. {“bankLocation”: “new york”} |
| bankCode | The bank code. {“bankCode”:”123456789”} |
| bankIban | The IBAN account number. {“bankIban”: “123456789”} |
| bankSwift | The BIC/SWIFT code of the bank. {“bankSwift”: “123456789”} |
GET Retrieve the shop company
Retrieve the shopCompany information from the shop.
Definition
GET /shop/company.json
Example request
$curl https://api.shoplightspeed.com/en/shop/company.json \
-u {key}:{secret}
<?php $api->shopCompany->get();
Example response
{
"shopCompany": {
"name": "api-test-shop",
"owner": null,
"cocNumber": "",
"cocLocation": null,
"vatNumber": "123456789",
"nationalId": "123456789",
"phone": "555-555-5555",
"email": "[email protected]",
"fax": "555-555-5555",
"street": "123 Street St.",
"street2": "Suite 123",
"zipcode": "10001",
"city": "New York",
"region": "New York",
"country": {
"id": 226,
"code": "us",
"code3": "usa",
"title": "United States"
},
"bankName": "The Bank",
"bankAccountHolder": "",
"bankAccountNumber": "",
"bankLocation": "new york",
"bankCode": "123456789",
"bankIban": "123456789",
"bankSwift": "123456789"
}
}
Arguments
| No arguments available. |