ReferenceCompanies
Update a company branch
Replaces one branch of the company and returns the stored row. Requires `Permissions.Companies.Update`.
PUT
Bearerheader
AuthorizationBearer <token>OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.
companyId*integerFormat
int32branchId*integerFormat
int32application/json- body
address1?|Length
length <= 80address2?|Length
length <= 80address3?|Length
length <= 80barcode?|Length
length <= 16branchCreationDate?|Format
date-timecity?|Length
length <= 80companyId?|Format
int32companyIdentificationNumber?|Length
length <= 50country?|Length
length <= 80countryId?|Format
int32customerId?|Format
int32deliveryDays?|Format
int32districtId?|Format
int32email1?|Length
length <= 80email2?|Length
length <= 80email3?|Length
length <= 80email4?|Length
length <= 80frameworkOrder?|Length
length <= 80gps?|Length
length <= 150homelandAbroadOwn?|Format
int32id?|Format
int32isB2BEnabled?boolean|nullisInactive?boolean|nulllinkB2BWarehouseId?|Format
int32linkUserId?|Format
int32linkWarehouseId?|Format
int32name?|Length
length <= 80note?string|nullnumber?|Length
length <= 20paymentTypeId?|Format
int32person1?|Length
length <= 80person2?|Length
length <= 80person3?|Length
length <= 80person4?|Length
length <= 80phone1?|Length
length <= 80phone2?|Length
length <= 80phone3?|Length
length <= 80phone4?|Length
length <= 80regionId?|Format
int32routeId?|Format
int32routeOrder?|Format
int32salesRepresentativeId?|Format
int32storeChainName?|Length
length <= 80transportTypeId?|Format
int32vatCode?|Length
length <= 5vatRegistrationNumber?|Length
length <= 50visitFrequency?|Length
length <= 20zipCode?|Length
length <= 50application/json- response
address1?|Length
length <= 80address2?|Length
length <= 80address3?|Length
length <= 80barcode?|Length
length <= 16branchCreationDate?|Format
date-timecity?|Length
length <= 80companyId?|Format
int32companyIdentificationNumber?|Length
length <= 50country?|Length
length <= 80countryId?|Format
int32customerId?|Format
int32deliveryDays?|Format
int32districtId?|Format
int32email1?|Length
length <= 80email2?|Length
length <= 80email3?|Length
length <= 80email4?|Length
length <= 80frameworkOrder?|Length
length <= 80gps?|Length
length <= 150homelandAbroadOwn?|Format
int32id?|Format
int32isB2BEnabled?boolean|nullisInactive?boolean|nulllinkB2BWarehouseId?|Format
int32linkUserId?|Format
int32linkWarehouseId?|Format
int32name?|Length
length <= 80note?string|nullnumber?|Length
length <= 20paymentTypeId?|Format
int32person1?|Length
length <= 80person2?|Length
length <= 80person3?|Length
length <= 80person4?|Length
length <= 80phone1?|Length
length <= 80phone2?|Length
length <= 80phone3?|Length
length <= 80phone4?|Length
length <= 80regionId?|Format
int32routeId?|Format
int32routeOrder?|Format
int32salesRepresentativeId?|Format
int32storeChainName?|Length
length <= 80transportTypeId?|Format
int32vatCode?|Length
length <= 5vatRegistrationNumber?|Length
length <= 50visitFrequency?|Length
length <= 20zipCode?|Length
length <= 50curl -X PUT 'https://<your-instance>/api/companies/0/branches/0' \ -H 'Authorization: Bearer <access-token>' \ -H 'Content-Type: application/json' \ -d '{ "address1": "Updated Street 45", "branchCreationDate": "2022-01-10T00:00:00", "city": "Brno", "companyId": 2, "companyIdentificationNumber": "87654321", "country": "Czech Republic", "countryId": 1, "customerId": 5, "deliveryDays": 5, "districtId": 102, "email1": "[email protected]", "gps": "49.1951,16.6068", "id": 12, "isB2BEnabled": true, "isInactive": false, "name": "Updated Downtown Branch", "note": "Branch moved to new location", "paymentTypeId": 3, "person1": "Petra Svobodová", "phone1": "+420 987 654 321", "regionId": 11, "routeId": 2, "routeOrder": 2, "salesRepresentativeId": 9, "storeChainName": "Market Central", "transportTypeId": 4, "vatCode": "CZ", "vatRegistrationNumber": "CZ87654321", "visitFrequency": "Monthly", "zipCode": "60200"}'{ "address1": "string", "address2": "string", "address3": "string", "barcode": "string", "branchCreationDate": "2019-08-24T14:15:22Z", "city": "string", "companyId": 0, "companyIdentificationNumber": "string", "country": "string", "countryId": 0, "customerId": 0, "deliveryDays": 0, "districtId": 0, "email1": "string", "email2": "string", "email3": "string", "email4": "string", "frameworkOrder": "string", "gps": "string", "homelandAbroadOwn": 0, "id": 0, "isB2BEnabled": true, "isInactive": true, "linkB2BWarehouseId": 0, "linkUserId": 0, "linkWarehouseId": 0, "name": "string", "note": "string", "number": "string", "paymentTypeId": 0, "person1": "string", "person2": "string", "person3": "string", "person4": "string", "phone1": "string", "phone2": "string", "phone3": "string", "phone4": "string", "regionId": 0, "routeId": 0, "routeOrder": 0, "salesRepresentativeId": 0, "storeChainName": "string", "transportTypeId": 0, "vatCode": "strin", "vatRegistrationNumber": "string", "visitFrequency": "string", "zipCode": "string"}Get a company branch GET
Returns one branch of the company. 404 when `branchId` does not belong to `companyId`. Requires `Permissions.Companies.View`.
List a company's cards GET
Returns the loyalty and customer cards registered for the company. Their barcodes are what `POST /api/documents/pos/shopping-session/{sessionId}/scan` resolves to a customer. Requires `Permissions.Companies.View`.