User Tools

Site Tools


services:api:customer:company

API to work with Companies

To get all companies

GET /api/v1/company
[
{ id: 'COMPANY01', code: 'COMP01', name: 'Company 01' },
{ id: 'COMPANY02', code: 'COMP02', name: 'Company 02' }
]

To get detail of Company with ID: COMPANY01
Detail can contain more information than list

GET /api/v1/company/-ID-
{
  code: "FUTAB",
  name: "FUTABA CZECH s.r.o.",
  address: [{
    type: "billing", // billing / shipping / ordering
    street: "Baštínov 130",
    zip: "58001",
    city: "Havličkův Brod",
    country: "ČESKÁ REPUBLIKA"
  }, {
    type: "shipping", // billing / shipping / ordering
    street: "2681 Wall Triana Highway",
    zip: "35824",
    city: "Huntsville",
    country: "USA, AL"
  }],
  contact: {
    name: "Radek Jaroš",
    phone: "+420 569 497 391",
    cellphone: "",
    fax: "+420 569 497 393"
  },
  update_pending: true|false,
}

??? To get Related Companies for example can contains facilities ??? can be implemented in future

GET /api/v1/company/-ID-?related=COMPANY
 

Update Company data

For update company (request update) sent only items which has to be updated

PUT /api/v1/company/-ID-
{
  address: 'Šámalova 60a',
}
services/api/customer/company.txt · Last modified: by zdenek

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki