AMCS Group Outlet API
The Outlet API from AMCS Group — 5 operation(s) for outlet.
OpenAPI Specification
openapi: 3.0.1
info:
title: Core AccessGroup Outlet API
version: core
tags:
- name: Outlet
paths:
/lists/outlets/{guid}:
get:
tags:
- Outlet
summary: Find with GUID
description: "| Property | Description|\r\n| ------------------------- | ----------------------------------------------------------------------------- |\r\n| GUID | The GUID associated to the outlet|\r\n| Description | The description of the outlet|\r\n| IsDeleted | Whether the outlet is deleted |\r\n| AbbreviatedDescription | The abbreviated description of the outlet|\r\n| AnalysisCode | The analysis code of the outlet|\r\n| CompanyListItem | The GUID and description of the company|\r\n| OutletTypeListItem | The GUID and description of the outlet type (various values)|\r\n| Address | The address object of the outlet|\r\n| Address.HouseNumber | The house number of the address object of the outlet|\r\n| Address.Address1 | The Address1 of the address object of the outlet|\r\n| Address.Address2 | The Address2 of the address object of the outlet|\r\n| Address.Address3 | The Address3 of the address object of the outlet|\r\n| Address.Address4 | The Address4 of the address object of the outlet|\r\n| Address.Address5 | The Address5 of the address object of the outlet|\r\n| Address.Postcode | The Postcode of the address object of the outlet| \r\n| DepartmentListItems| The GUID and description of departments associated to the outlet|\r\n| VATRegistrationNumber | The VAT Registration Number of the outlet|\r\n| RelatedLocationGuid | The RelatedLocationGuid of the outlet. Filterable|\r\n| AcceptedMaterials[]| The materials accepted of the outlet|\r\n| AcceptedMaterials[].MaterialListItem| The materialListItem of the materials accepted for the outlet|\r\n| AcceptedMaterials[].WarnOnMinimumLoad| The WarnOnMinimumLoad of the materials accepted for the outlet|\r\n| AcceptedMaterials[].MinimumLoadWeight| The MinimumLoadWeight of the materials accepted for the outlet|\r\n| AcceptedMaterials[].IsDeleted | Whether the materials accepted for the outlet is deleted|\r\n| AcceptedMaterials[].GUID | The GUID of the materials accepted for the outlet|\r\n| AnalysisCodes| The list of company outlet analysis codes associated to the outlet.|\r\n| AnalysisCodes[0].Guid| The guid associated to the company outlet analysis code.|\r\n| AnalysisCodes[0].Description| The Description of the company outlet analysis code.|\r\n| AnalysisCodes[0].IsDeleted| Whether the company outlet analysis code is deleted.|"
operationId: Outlet_Get
parameters:
- name: guid
in: path
required: true
schema:
type: string
format: uuid
- name: udf
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResultEntity[ApiIntegratorCompanyOutletResource]'
/lists/outlets:
get:
tags:
- Outlet
summary: Find with Filters
description: "| Property | Description|\r\n| ------------------------- | ----------------------------------------------------------------------------- |\r\n| GUID | The GUID associated to the outlet|\r\n| Description | The description of the outlet|\r\n| IsDeleted | Whether the outlet is deleted |\r\n| AbbreviatedDescription | The abbreviated description of the outlet|\r\n| AnalysisCode | The analysis code of the outlet|\r\n| CompanyListItem | The GUID and description of the company|\r\n| OutletTypeListItem | The GUID and description of the outlet type (various values)|\r\n| Address | The address object of the outlet|\r\n| Address.HouseNumber | The house number of the address object of the outlet|\r\n| Address.Address1 | The Address1 of the address object of the outlet|\r\n| Address.Address2 | The Address2 of the address object of the outlet|\r\n| Address.Address3 | The Address3 of the address object of the outlet|\r\n| Address.Address4 | The Address4 of the address object of the outlet|\r\n| Address.Address5 | The Address5 of the address object of the outlet|\r\n| Address.Postcode | The Postcode of the address object of the outlet| \r\n| DepartmentListItems| The GUID and description of departments associated to the outlet|\r\n| VATRegistrationNumber | The VAT Registration Number of the outlet|\r\n| RelatedLocationGuid | The RelatedLocationGuid of the outlet. Filterable|\r\n| AcceptedMaterials[]| The materials accepted of the outlet|\r\n| AcceptedMaterials[].MaterialListItem| The materialListItem of the materials accepted for the outlet|\r\n| AcceptedMaterials[].WarnOnMinimumLoad| The WarnOnMinimumLoad of the materials accepted for the outlet|\r\n| AcceptedMaterials[].MinimumLoadWeight| The MinimumLoadWeight of the materials accepted for the outlet|\r\n| AcceptedMaterials[].IsDeleted | Whether the materials accepted for the outlet is deleted|\r\n| AcceptedMaterials[].GUID | The GUID of the materials accepted for the outlet|\r\n| AnalysisCodes| The list of company outlet analysis codes associated to the outlet.|\r\n| AnalysisCodes[0].Guid| The guid associated to the company outlet analysis code.|\r\n| AnalysisCodes[0].Description| The Description of the company outlet analysis code.|\r\n| AnalysisCodes[0].IsDeleted| Whether the company outlet analysis code is deleted.|"
operationId: Outlet_GetCollection
parameters:
- name: filter
in: query
schema:
type: string
- name: max
in: query
schema:
type: integer
format: int32
- name: page
in: query
schema:
type: integer
format: int32
- name: includeCount
in: query
schema:
type: boolean
- name: udf
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResultCollection[ApiIntegratorCompanyOutletResource]'
/integrator/lists/outlets/{id}:
get:
tags:
- Outlet
summary: Find with GUID
description: "| Property | Description |\r\n| ---------------------------------------------------- | ---------------------------------------------------------------------------------- |\r\n| GUID | The GUID associated to the outlet |\r\n| Description | The description of the outlet |\r\n| IsDeleted | Whether the outlet is deleted |\r\n| AbbreviatedDescription | The abbreviated description of the outlet |\r\n| AnalysisCode | The analysis code of the outlet |\r\n| Location | The description of the weighing type |\r\n| Address | The address object of the outlet |\r\n| Address.HouseNumber | The house number of the address object of the outlet |\r\n| Address.Address1 | The Address1 of the address object of the outlet |\r\n| Address.Address2 | The Address2 of the address object of the outlet |\r\n| Address.Address3 | The Address3 of the address object of the outlet |\r\n| Address.Address4 | The Address4 of the address object of the outlet |\r\n| Address.Address5 | The Address5 of the address object of the outlet |\r\n| Address.Postcode | The Postcode of the address object of the outlet |\r\n| CompanyOutletMaterial[] | The materials accepted of the outlet |\r\n| CompanyOutletMaterial[].MaterialListItem | The materialListItem of the materials accepted for the outlet |\r\n| CompanyOutletMaterial[].MaterialListItem.Description | The materialListItem material description of the materials accepted for the outlet |\r\n| CompanyOutletMaterial[].MaterialListItem.GUID | The materialListItem material GUID of the materials accepted for the outlet |\r\n| CompanyOutletMaterial[].Guid | The company outlet accepted material GUID |\r\n| OutletSupplierSite[] | The outlet Supplier Site Object |\r\n| OutletSupplierSite[].Address | The outlet Supplier Site Address Object |\r\n| OutletSupplierSite[].Address.Location | The Location of the outlet Supplier Site address |\r\n| OutletSupplierSite[].Address.HouseNumber | The House Number of the outlet Supplier Site address |\r\n| OutletSupplierSite[].Address.Address1 | Address1 of the outlet Supplier Site address |\r\n| OutletSupplierSite[].Address.Address2 | Address2 of the outlet Supplier Site address |\r\n| OutletSupplierSite[].Address.Address3 | Address3 of the outlet Supplier Site address |\r\n| OutletSupplierSite[].Address.Address4 | Address4 of the outlet Supplier Site address |\r\n| OutletSupplierSite[].Address.Address5 | Address5 of the outlet Supplier Site address |\r\n| OutletSupplierSite[].Address.Postcode | The outlet Supplier Site Postcode |\r\n| OutletSupplierSite[].SupplierName | The outlet Supplier Name |\r\n| OutletSupplierSite[].RelatedSupplierSiteGUID | The Related Supplier Site GUID of the outlet |\r\n| OutletSupplierSite[].GUID | The GUID of the Company Outlet Supplier Site |\r\n| VATRegistrationNumber | The VAT Registration Number of the outlet |\r\n| Company | The Company that the outlet is associated with |\r\n| NominalPrefix | The Nominal Prefix of the outlet |\r\n| TelNo | The Telephone number of the outlet |\r\n| ContactEmail | The Contact Email of the outlet |\r\n| PremisesRegNo | The Premises Registration Number of the outlet |\r\n| WasteCarrierLicenceNumber | The Waste Carrier Licence Number of the outlet |\r\n| WasteCarrierLicenceIssuedBy | Who the Waste Carrier Licence was issued by to the outlet |\r\n| IsDriversLicenceRequired | Whether Drivers Licence is required |\r\n| IsCashDepositRequired | Whether Cash Deposit is required |\r\n| IsValidWasteCarrierLicenceRequired | Whether a Valid Waste Carrier Licence is required |\r\n| DepositValueRequired | Whether a Deposit Value is Required |\r\n| WasteManagementLicenceNumber | The Waste Management Licence Number |\r\n| WasteManagementIssuedBy | Who the Waste Management is issued by |\r\n| IsAutoLoadVehicleStoredTares | Whether Auto Load Vehicle Stored Tares |\r\n| ShowANPRReads | Whether to Show ANPR Reads |\r\n| EPAId | The EPAId of the outlet |\r\n| AmiceNumber | The Amice Number of the outlet |\r\n| ReportToExternalAuthorities | Whether to Report to External Authorities |\r\n| LegislationType | The Legislation Type of the outlet |\r\n| WeightUnitOfMeasurement | The Weight Unit of Measurement of the outlet |\r\n| ReportingUnitOfMeasurement | The Reporting Unit of Measurement of the outlet |\r\n| VolumeUnitOfMeasurement | The Volume Unit of Measurement of the outlet |\r\n| GateWeighbridgeDocket | The outlet Gete Weighbridge Docket report path |\r\n| MaterialSaleWeighbridgeDocket | The outlet Material Sale Weighbridge Docket report path |\r\n| RouteWeighbridgeDocket | The outlet Route Weighbridge Docket report path |\r\n| TransferOutWeighbridgeDocket | The outlet Transfer Out Weighbridge Docket report path |\r\n| TransferInWeighbridgeDocket | The outlet Transfer In Weighbridge Docket report path |\r\n| ScaleReceiptWeighbridgeDocket | The outlet Scale Reciept Weighbridge Docket report path |\r\n| BillOfLadingWeighbridgeDocket | The outlet Bill of Lading Weighbridge Docket report path |\r\n| VZCReport | The outlet VZC report path |\r\n| CMRReport | The outlet CMR report path |\r\n| CurrencyCode | The Currency Code of the outlet |\r\n\t\t\t\t "
operationId: Outlet_Get
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
format: uuid
- name: links
in: query
required: false
type: string
- name: include
in: query
required: false
type: string
- name: expand
in: query
required: false
type: string
- name: udf
in: query
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResourceResultEntity[ApiCompanyOutletResource]'
/integrator/lists/outlets:
get:
tags:
- Outlet
summary: Find with Filters
description: "| Property | Description |\r\n| ---------------------------------------------------- | ---------------------------------------------------------------------------------- |\r\n| GUID | The GUID associated to the outlet |\r\n| Description | The description of the outlet |\r\n| IsDeleted | Whether the outlet is deleted |\r\n| AbbreviatedDescription | The abbreviated description of the outlet |\r\n| AnalysisCode | The analysis code of the outlet |\r\n| Location | The description of the weighing type |\r\n| Address | The address object of the outlet |\r\n| Address.HouseNumber | The house number of the address object of the outlet |\r\n| Address.Address1 | The Address1 of the address object of the outlet |\r\n| Address.Address2 | The Address2 of the address object of the outlet |\r\n| Address.Address3 | The Address3 of the address object of the outlet |\r\n| Address.Address4 | The Address4 of the address object of the outlet |\r\n| Address.Address5 | The Address5 of the address object of the outlet |\r\n| Address.Postcode | The Postcode of the address object of the outlet |\r\n| CompanyOutletMaterial[] | The materials accepted of the outlet |\r\n| CompanyOutletMaterial[].MaterialListItem | The materialListItem of the materials accepted for the outlet |\r\n| CompanyOutletMaterial[].MaterialListItem.Description | The materialListItem material description of the materials accepted for the outlet |\r\n| CompanyOutletMaterial[].MaterialListItem.GUID | The materialListItem material GUID of the materials accepted for the outlet |\r\n| CompanyOutletMaterial[].Guid | The company outlet accepted material GUID |\r\n| OutletSupplierSite[] | The outlet Supplier Site Object |\r\n| OutletSupplierSite[].Address | The outlet Supplier Site Address Object |\r\n| OutletSupplierSite[].Address.Location | The Location of the outlet Supplier Site address |\r\n| OutletSupplierSite[].Address.HouseNumber | The House Number of the outlet Supplier Site address |\r\n| OutletSupplierSite[].Address.Address1 | Address1 of the outlet Supplier Site address |\r\n| OutletSupplierSite[].Address.Address2 | Address2 of the outlet Supplier Site address |\r\n| OutletSupplierSite[].Address.Address3 | Address3 of the outlet Supplier Site address |\r\n| OutletSupplierSite[].Address.Address4 | Address4 of the outlet Supplier Site address |\r\n| OutletSupplierSite[].Address.Address5 | Address5 of the outlet Supplier Site address |\r\n| OutletSupplierSite[].Address.Postcode | The outlet Supplier Site Postcode |\r\n| OutletSupplierSite[].SupplierName | The outlet Supplier Name |\r\n| OutletSupplierSite[].RelatedSupplierSiteGUID | The Related Supplier Site GUID of the outlet |\r\n| OutletSupplierSite[].GUID | The GUID of the Company Outlet Supplier Site |\r\n| VATRegistrationNumber | The VAT Registration Number of the outlet |\r\n| Company | The Company that the outlet is associated with |\r\n| NominalPrefix | The Nominal Prefix of the outlet |\r\n| TelNo | The Telephone number of the outlet |\r\n| ContactEmail | The Contact Email of the outlet |\r\n| PremisesRegNo | The Premises Registration Number of the outlet |\r\n| WasteCarrierLicenceNumber | The Waste Carrier Licence Number of the outlet |\r\n| WasteCarrierLicenceIssuedBy | Who the Waste Carrier Licence was issued by to the outlet |\r\n| IsDriversLicenceRequired | Whether Drivers Licence is required |\r\n| IsCashDepositRequired | Whether Cash Deposit is required |\r\n| IsValidWasteCarrierLicenceRequired | Whether a Valid Waste Carrier Licence is required |\r\n| DepositValueRequired | Whether a Deposit Value is Required |\r\n| WasteManagementLicenceNumber | The Waste Management Licence Number |\r\n| WasteManagementIssuedBy | Who the Waste Management is issued by |\r\n| IsAutoLoadVehicleStoredTares | Whether Auto Load Vehicle Stored Tares |\r\n| ShowANPRReads | Whether to Show ANPR Reads |\r\n| EPAId | The EPAId of the outlet |\r\n| AmiceNumber | The Amice Number of the outlet |\r\n| ReportToExternalAuthorities | Whether to Report to External Authorities |\r\n| LegislationType | The Legislation Type of the outlet |\r\n| WeightUnitOfMeasurement | The Weight Unit of Measurement of the outlet |\r\n| ReportingUnitOfMeasurement | The Reporting Unit of Measurement of the outlet |\r\n| VolumeUnitOfMeasurement | The Volume Unit of Measurement of the outlet |\r\n| GateWeighbridgeDocket | The outlet Gete Weighbridge Docket report path |\r\n| MaterialSaleWeighbridgeDocket | The outlet Material Sale Weighbridge Docket report path |\r\n| RouteWeighbridgeDocket | The outlet Route Weighbridge Docket report path |\r\n| TransferOutWeighbridgeDocket | The outlet Transfer Out Weighbridge Docket report path |\r\n| TransferInWeighbridgeDocket | The outlet Transfer In Weighbridge Docket report path |\r\n| ScaleReceiptWeighbridgeDocket | The outlet Scale Reciept Weighbridge Docket report path |\r\n| BillOfLadingWeighbridgeDocket | The outlet Bill of Lading Weighbridge Docket report path |\r\n| VZCReport | The outlet VZC report path |\r\n| CMRReport | The outlet CMR report path |\r\n| CurrencyCode | The Currency Code of the outlet |\r\n\t\t\t\t "
operationId: Outlet_GetCollection
consumes:
- application/json
produces:
- application/json
parameters:
- name: filter
in: query
required: false
type: string
- name: search
in: query
required: false
type: string
- name: order
in: query
required: false
type: string
- name: max
in: query
required: false
type: integer
format: int32
- name: page
in: query
required: false
type: integer
format: int32
- name: includeCount
in: query
required: false
type: boolean
- name: includeDeleted
in: query
required: false
type: boolean
- name: links
in: query
required: false
type: string
- name: udf
in: query
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResourceResultCollection[ApiCompanyOutletResource]'
/visionai/api/integrator/outlets:
post:
tags:
- Outlet
summary: Create or Update an Outlet
description: "# Create or Update an Outlet\r\n\r\n| Parameter | Type | Description |\r\n|-------------|--------|----------------------------------|\r\n| OutletId | GUID | ID of the Outlet |\r\n| OutletName | string | Display name |\r\n| IsDeleted | bool | Outlet is no longer in use |\r\n\r\n## Sample API Requests\r\n\r\n```\r\n{\r\n \"OutletId\": \"B3E43C4D-BC76-4E59-9E2E-25BC33EA2EC4\",\r\n \"OutletName\": \"Primary Company Outlet\",\r\n \"IsDeleted\": false\r\n}\r\n```"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AMCS.IoT.Contamination.Api.Integrator.Outlet.ApiOutlet'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
'400':
$ref: '#/components/responses/BadRequest'
'401':
description: Unauthorized
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
'502':
$ref: '#/components/responses/BadGateway'
'503':
$ref: '#/components/responses/ServiceUnavailable'
'504':
$ref: '#/components/responses/GatewayTimeout'
components:
schemas:
ApiResourceResultCollectionExtra:
type: object
properties:
count:
type: integer
format: int32
ApiResourceStatus:
type: object
properties:
id:
type: integer
format: int32
isSuccess:
type: boolean
ApiResourceResultCollection[ApiIntegratorCompanyOutletResource]:
type: object
properties:
resource:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorCompanyOutletResource'
extra:
$ref: '#/components/schemas/ApiResourceResultCollectionExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceResultEntity[ApiIntegratorCompanyOutletResource]:
type: object
properties:
resource:
$ref: '#/components/schemas/ApiIntegratorCompanyOutletResource'
links:
$ref: '#/components/schemas/ApiResourceResultEntityLinks'
extra:
$ref: '#/components/schemas/ApiResourceResultEntityExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiIntegratorCompanyOutletResource:
type: object
properties:
Description:
type: string
IsDeleted:
type: boolean
AbbreviatedDescription:
type: string
AnalysisCode:
type: string
CompanyListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
OutletTypeListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
Address:
$ref: '#/components/schemas/ApiIntegratorCompanyOutletAddressResource'
DepartmentListItems:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
AcceptedMaterials:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorCompanyOutletAcceptedMaterialResource'
AnalysisCodes:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorCompanyOutletAnalysisCodesResource'
VATRegistrationNumber:
type: string
RelatedLocationGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
GUID:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ApiIntegratorListItemResource:
type: object
properties:
Description:
type: string
Guid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ApiIntegratorCompanyOutletAcceptedMaterialResource:
type: object
properties:
WarnOnMinimumLoad:
type: boolean
MinimumLoadWeight:
type: number
format: double
# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amcs-group/refs/heads/main/openapi/amcs-group-outlet-api-openapi.yml