AMCS Group Order API
The Order API from AMCS Group — 3 operation(s) for order.
The Order API from AMCS Group — 3 operation(s) for order.
openapi: 3.0.1
info:
title: Core AccessGroup Order API
version: core
tags:
- name: Order
paths:
/transport/orders/changes:
get:
tags:
- Order
summary: Retrieve changes
description: "| Property| Description|\r\n| ------------------------------------------------- | ------------------------------------------------------------------------------------------------- |\r\n| GUID| The GUID associated to the site order.|\r\n| RelatedSiteGuid| The GUID associated to the customer site of the site order.|\r\n| RelatedSiteAreaGuid| The GUID associated to the customer site area of the site order.|\r\n| RelatedSupplierSiteForServiceGuid| The GUID associated to the supplier site for service of the site order.|\r\n| RelatedSupplierSiteForTransportGuid| The GUID associated to the supplier site for transport of the site order.|\r\n| RelatedUserSalesRepGuid| The GUID associated to the sales rep of the site order.| \r\n| RelatedServiceAgreementGuid| The GUID associated to the service agreement of the site order.|\r\n| RelatedPONumberChainGuid| The GUID associated to the purchase order number chain of the site order.|\r\n| OrderNumber| Used to filter the order number associated to the site order.|\r\n| CustomerOrderNumber| The customer order number associated to the site order.|\r\n| OrderedBy| The ordered by associated to the site order.|\r\n| ProcessFrom| The process from date associated to the site order in ISO format (YYYY-MM-DD).|\r\n| ValidUntil| The valid until date associated to the site order in ISO format (YYYY-MM-DD).|\r\n| Notes| The notes associated to the site order.|\r\n| DriverNotes| The driver notes associated to the site order.|\r\n| IsCustomerOwnedEquipment| Is the equipment used in the site order customer owned?|\r\n| CompanyOutletListItem| The GUID and description of the company outlet associated to the site order.|\r\n| ServiceListItem| The GUID and description of the service associated to the site order.|\r\n| MaterialListItem| The GUID and description of the material associated to the site order.|\r\n| DefaultContainerTypeListItem| The GUID and description of the container type associated to the site order.|\r\n| PriorityListItem| The GUID and description of the priority associated to the site order.|\r\n| PaymentTypeListItem| The GUID and description of the payment type associated to the site order.|\r\n| Containers[0]| The list of site order items associated to the site order.|\r\n| Containers[0].Guid| The GUID associated to the site order item.|\r\n| Containers[0].IsDeleted| Whether the site order item is deleted.|\r\n| Containers[0].Notes| The Notes associated to the site order item.|\r\n| Containers[0].IsContainerAssignedWithoutJob | Whether the container is assigned without job.|\r\n| Containers[0].IsFromIncreasedOrder | Whether the container is from increased order.|\r\n| Containers[0].IsContainerRemovedWithoutJob | Whether the container is removed without job.|\r\n| Containers[0].IsFixLocation | Whether the container has a fixed location.|\r\n| Containers[0].Geo | The Geo Location associated to the site order item.|\r\n| Containers[0].Geo.Location.Lat| The latitude of Geo Location associated to the site order item.|\r\n| Containers[0].Geo.Location.Long| The longitude of Geo Location associated to the site order item.|\r\n| Containers[0].StartDate | The StartDate associated to the site order item.|\r\n| Containers[0].EndDate| The EndDate associated to the site order item.|\r\n| Containers[0].DateLinked | The DateLinked associated to the site order item.|\r\n| Containers[0].RelatedContainerGuid| The GUID associated to the container of the site order item.|\r\n| Containers[0].ContainerTypeListItem| The GUID and description of the container type associated to site order item.|\r\n| Containers[0].ContainerStateListItem| The GUID and description of the site order item state associated to site order item.|\r\n| RelatedLocationDestinationGuid| Used to filter the related destination location guid associated to the site order. |\r\n| IsDeleted| Whether the site order is deleted.|\r\n| ItemRentals| The list of site order item rentals associated to the site order.|\r\n| ItemRentals[0].RelatedPriceGuid| The GUID associated to the price of the site order item rental.|\r\n| ItemRentals[0].RelatedPriceModifierGuid| The GUID associated to the price modifier of the site order item rental.|\r\n| ItemRentals[0].RelatedCostGuid| The GUID associated to the cost of the site order item rental.|\r\n| ItemRentals[0].ContainerTypeListItem| The GUID and description of the container type associated to site order item rental.|\r\n| ItemRentals[0].ActionListItem| The GUID and description of the action associated to site order item rental.|\r\n| ItemRentals[0].StartDate| The start date associated to the site order item rental in ISO format (YYYY-MM-DD).|\r\n| ItemRentals[0].EndDate| The end date associated to the site order item rental in ISO format (YYYY-MM-DD).|\r\n| ItemRentals[0].IsStartOnStartOfCycle| Start on start of cycle when site order item rental.|\r\n| ItemRentals[0].IsEndOnEndOfCycle| End on start of cycle when site order item rental.|\r\n| ItemRentals[0].Quantity| The quantity associated to the site order item rental.|\r\n| ItemRentals[0].Notes| The notes associated to the site order item rental.|\r\n| ItemRentals[0].IsArrears| Is the site order item rental in arrears?|\r\n| ItemRentals[0].RentalQuantityAttributeListItem| The GUID and description of the rental quantity attribute associated to site order item rental.|\r\n| ItemRentals[0].IsBinOnSiteBasedOnQuantityNow| Is the bin on site are based on quantity for site order item rental?|\r\n| ItemRentals[0].IsDiscount| Is the site order item rental discounted?|\r\n| ItemRentals[0].DiscountOverridePrice| The discount override price associated to the site order item rental.|\r\n| ItemRentals[0].DiscountReasonListItem| The GUID and description of the discount reason associated to site order item rental.|\r\n| ItemRentals[0].Guid| The GUID associated to the site order item rental.|\r\n| ItemRentals[0].IsDeleted| Whether the site order item rental is deleted.|\r\n| PermitRequired| Whether the site order has required permit.|\r\n| RelatedPriceGuidFilter| Used to filter by the related price GUID.|\r\n| RelatedPriceModifierGuidFilter| Used to filter by the related price modifier GUID.|\r\n| RelatedCostGuidFilter| Used to filter by the related cost GUID.|\r\n| AreaOfOriginListItem| The GUID and description of the area of origin associated to the site order.|\r\n| StandingJobs| The list of standing job template associated to the site order.|\r\n| StandingJobs[0].Guid| The GUID associated to the standing job template of site order.|\r\n| StandingJobs[0].ActionListItem| The GUID and description of the action associated to site order standing job|\r\n| StandingJobs[0].ContainerTypeListItem| The GUID and description of the containertype associated to site order standing job|\r\n| StandingJobs[0].EndOnJobCompletion| Is job completion on end for standing job|\r\n| StandingJobs[0].ExcludeNoBinOnSite| Exclude no bin on site for standing job|\r\n| StandingJobs[0].IsNoPlannedDay| Is on no planned day for standing job|\r\n| StandingJobs[0].PickupIntervalListItem| The GUID and description of the pickup interval associated to site order standing job|\r\n| StandingJobs[0].StartDate| The start date associated to the standing job.|\r\n| StandingJobs[0].EndDate| The end date associated to the standing job.|\r\n| StandingJobs[0].CompanyOutletListItem| The GUID and description of the companyoutlet associated to site order standing job|\r\n| StandingJobs[0].RelatedSiteAreaGuid| The GUID associated to the customer site area of the site order standing job.|\r\n| StandingJobs[0].DayOfWeekListItem| The GUID and description of the day of week associated to site order standing job|\r\n| StandingJobs[0].RelatedSysUserDriverGuid| The GUID associated to the sriver sysuser of the site order standing job.|\r\n| StandingJobs[0].RelatedVehicleGuid| The GUID associated to the vehcile of the site order standing job.|\r\n| StandingJobs[0].RequestedBy| Requested by details of standing job.|\r\n| StandingJobs[0].IsDeleted| Whether the standing job related to the siteorderis deleted.|\r\n| StandingJobsSiteAreaGuidFilter| Used to filter by the standing job site area guid.|\r\n| StandingJobsSysUserDriverGuidFilter| Used to filter by the standing job sysuser driver guid.|\r\n| StandingJobsVehicleGuidFilter| Used to filter by the standing job vehicle guid.|\r\n| StandingJobsStartDateFilter| Used to filter by the standing job start date.|\r\n| StandingJobsEndDateFilter| Used to filter by the standing job end date.|\r\n| InspectionTypeListItem| The GUID and description of the inspection type associated to the site order.|\r\n| ItemTimeStamp| The item timestamp of the site order.|\r\n| RouteAssignments| The list of route assignments associated to the site order.|\r\n| RouteAssignments[0].Guid| The guid associated to the route assignment.|\r\n| RouteAssignments[0].ActionListItem| The GUID and description of the action associated to site order route assignment|\r\n| RouteAssignments[0].ContainerTypeListItem| The GUID and description of the containertype associated to site order route assignment|\r\n| RouteAssignments[0].PickupIntervalListItem| The GUID and description of the pickup interval associated to site order route assignment|\r\n| RouteAssignments[0].DayOfWeekListItem| The GUID and description of the day of week associated to site order route assignment|\r\n| RouteAssignments[0].DayOfOccurrenceInMonthListItem| The GUID and description of the day of occurrence in month associated to site order route assignment|\r\n| RouteAssignments[0].Position| The position associated to the routeAssignment.|\r\n| RouteAssignments[0].StartDate| The start date associated to the route assignment in ISO format (YYYY-MM-DD).|\r\n| RouteAssignments[0].EndDate| The end date associated to the route assignment in ISO format (YYYY-MM-DD).|\r\n| RouteAssignments[0].RequestedBy| Who is the routeAssignment requested by?|\r\n| RouteAssignments[0].Notes| The notes associated to the routeAssignment.|\r\n| RouteAssignments[0].MaxLiftQuantity| The max lift quantity associated to the routeAssignment.|\r\n| RouteAssignments[0].MinLiftQuantity| The min lift quantity associated to the routeAssignment.|\r\n| RouteAssignments[0].RequiresQuantity| Does the routeAssignment require quantity?|\r\n| RouteAssignments[0].IsGpsAutoMatchingDisabled| Is the GPS auto matching disabled for the routeAssignment?|\r\n| RouteAssignments[0].IsNoPlannedDate| Is there no planned date for the routeAssignment?|\r\n| RouteAssignments[0].IsNoBinOnSiteExcluded| Is the bin on site excluded for the routeAssignment? |\r\n| RouteAssignments[0].RelatedRouteTemplateGuid| The guid associated to the route template to the routeAssignment.|\r\n| RouteAssignments[0].RelatedSiteAreaGuid| The guid associated to the site area of the route assignment.|\r\n| RouteAssignments[0].IsDeleted| Whether the site order route assignment is deleted.|\r\n| RouteAssignments[0].Exclusions| The list of exclusions associated to the route assignment.|\r\n| RouteAssignments[0].Exclusions[0].Guid| The guid associated to the exclusion.|\r\n| RouteAssignments[0].Exclusions[0].ExcludeFrom| The exclude from date associated to the exclusion.|\r\n| RouteAssignments[0].Exclusions[0].ExcludeTo| The exclude to date associated to the exclusion.|\r\n| RouteAssignments[0].Exclusions[0].ExclusionTypeListItem| The guid and description of the exclusion type associated to the exclusion.|\r\n| RouteAssignments[0].Exclusions[0].ReasonListItem| The guid and description of the reason associated to the exclusion.|\r\n| RouteAssignments[0].Exclusions[0].Notes| The notes associated to the exclusion.|\r\n| RouteCalloutRequests| The list of route callout requests associated to the site order.|\r\n| RouteCalloutRequests[0].Guid| The guid associated to the route callout request.|\r\n| RouteCalloutRequests[0].ActionListItem| The GUID and description of the action associated to site order route callout request|\r\n| RouteCalloutRequests[0].OutletListItem | The GUID and description of the company outlet associated to site order route callout request|\r\n| RouteCalloutRequests[0].ContainerTypeListItem| The GUID and description of the containertype associated to site order route callout request|\r\n| RouteCalloutRequests[0].DateRequired| The date required of the route callout request|\r\n| RouteCalloutRequests[0].Notes| The notes of the route callout request|\r\n| RouteCalloutRequests[0].RelatedRouteVisitGuid| The guid associated to the routevisit of the route callout request.|\r\n| RouteCalloutRequests[0].RequestedBy| Who requested the route callout request.|\r\n| RouteCalloutRequests[0].MaxLiftQuantity| The max lift quantity of the route callout request.|\r\n| RouteCalloutRequests[0].IsDeleted| Whether the route callout request is deleted.|\r\n| RouteAssignmentSiteAreaGuidFilter| Used to filter by the related route assignment site area GUID. |\r\n| RouteAssignmentStartDateFilter | Used to filter by the related route assignment start date|\r\n| RouteAssignmentEndDateFilter | Used to filter by the related route assignment end date|\r\n| RelatedContainerGuidFilter| Used to filter by the related container GUID.|\r\n| RelatedOrderCombinationGroupingGuid| The GUID associated to the order combination grouping. Filterable|\r\n| ContainersGeoLocationLatFilter| Used to filter by the location latitude of the site order item|\r\n| ContainersGeoLocationLongFilter| Used to filter by the location longitude of the site order item|\r\n| RelatedRouteVisitGuidFilter| Used to filter by the related routevisit GUID.|\r\n| RouteCalloutRequestGuidFilter| Used to filter by the route callout request GUID|"
operationId: Order_GetChanges
parameters:
- name: since
in: query
schema:
type: string
- name: cursor
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceChanges[ApiIntegratorOrderResource]'
/transport/orders/{guid}:
get:
tags:
- Order
summary: Find with GUID
description: "| Property| Description|\r\n| ------------------------------------------------- | ------------------------------------------------------------------------------------------------- |\r\n| GUID| The GUID associated to the site order.|\r\n| RelatedSiteGuid| The GUID associated to the customer site of the site order.|\r\n| RelatedSiteAreaGuid| The GUID associated to the customer site area of the site order.|\r\n| RelatedSupplierSiteForServiceGuid| The GUID associated to the supplier site for service of the site order.|\r\n| RelatedSupplierSiteForTransportGuid| The GUID associated to the supplier site for transport of the site order.|\r\n| RelatedUserSalesRepGuid| The GUID associated to the sales rep of the site order.| \r\n| RelatedServiceAgreementGuid| The GUID associated to the service agreement of the site order.|\r\n| RelatedPONumberChainGuid| The GUID associated to the purchase order number chain of the site order.|\r\n| OrderNumber| Used to filter the order number associated to the site order.|\r\n| CustomerOrderNumber| The customer order number associated to the site order.|\r\n| OrderedBy| The ordered by associated to the site order.|\r\n| ProcessFrom| The process from date associated to the site order in ISO format (YYYY-MM-DD).|\r\n| ValidUntil| The valid until date associated to the site order in ISO format (YYYY-MM-DD).|\r\n| Notes| The notes associated to the site order.|\r\n| DriverNotes| The driver notes associated to the site order.|\r\n| IsCustomerOwnedEquipment| Is the equipment used in the site order customer owned?|\r\n| CompanyOutletListItem| The GUID and description of the company outlet associated to the site order.|\r\n| ServiceListItem| The GUID and description of the service associated to the site order.|\r\n| MaterialListItem| The GUID and description of the material associated to the site order.|\r\n| DefaultContainerTypeListItem| The GUID and description of the container type associated to the site order.|\r\n| PriorityListItem| The GUID and description of the priority associated to the site order.|\r\n| PaymentTypeListItem| The GUID and description of the payment type associated to the site order.|\r\n| Containers[0]| The list of site order items associated to the site order.|\r\n| Containers[0].Guid| The GUID associated to the site order item.|\r\n| Containers[0].IsDeleted| Whether the site order item is deleted.|\r\n| Containers[0].Notes| The Notes associated to the site order item.|\r\n| Containers[0].IsContainerAssignedWithoutJob | Whether the container is assigned without job.|\r\n| Containers[0].IsFromIncreasedOrder | Whether the container is from increased order.|\r\n| Containers[0].IsContainerRemovedWithoutJob | Whether the container is removed without job.|\r\n| Containers[0].IsFixLocation | Whether the container has a fixed location.|\r\n| Containers[0].Geo | The Geo Location associated to the site order item.|\r\n| Containers[0].Geo.Location.Lat| The latitude of Geo Location associated to the site order item.|\r\n| Containers[0].Geo.Location.Long| The longitude of Geo Location associated to the site order item.|\r\n| Containers[0].StartDate | The StartDate associated to the site order item.|\r\n| Containers[0].EndDate| The EndDate associated to the site order item.|\r\n| Containers[0].DateLinked | The DateLinked associated to the site order item.|\r\n| Containers[0].RelatedContainerGuid| The GUID associated to the container of the site order item.|\r\n| Containers[0].ContainerTypeListItem| The GUID and description of the container type associated to site order item.|\r\n| Containers[0].ContainerStateListItem| The GUID and description of the site order item state associated to site order item.|\r\n| RelatedLocationDestinationGuid| Used to filter the related destination location guid associated to the site order. |\r\n| IsDeleted| Whether the site order is deleted.|\r\n| ItemRentals| The list of site order item rentals associated to the site order.|\r\n| ItemRentals[0].RelatedPriceGuid| The GUID associated to the price of the site order item rental.|\r\n| ItemRentals[0].RelatedPriceModifierGuid| The GUID associated to the price modifier of the site order item rental.|\r\n| ItemRentals[0].RelatedCostGuid| The GUID associated to the cost of the site order item rental.|\r\n| ItemRentals[0].ContainerTypeListItem| The GUID and description of the container type associated to site order item rental.|\r\n| ItemRentals[0].ActionListItem| The GUID and description of the action associated to site order item rental.|\r\n| ItemRentals[0].StartDate| The start date associated to the site order item rental in ISO format (YYYY-MM-DD).|\r\n| ItemRentals[0].EndDate| The end date associated to the site order item rental in ISO format (YYYY-MM-DD).|\r\n| ItemRentals[0].IsStartOnStartOfCycle| Start on start of cycle when site order item rental.|\r\n| ItemRentals[0].IsEndOnEndOfCycle| End on start of cycle when site order item rental.|\r\n| ItemRentals[0].Quantity| The quantity associated to the site order item rental.|\r\n| ItemRentals[0].Notes| The notes associated to the site order item rental.|\r\n| ItemRentals[0].IsArrears| Is the site order item rental in arrears?|\r\n| ItemRentals[0].RentalQuantityAttributeListItem| The GUID and description of the rental quantity attribute associated to site order item rental.|\r\n| ItemRentals[0].IsBinOnSiteBasedOnQuantityNow| Is the bin on site are based on quantity for site order item rental?|\r\n| ItemRentals[0].IsDiscount| Is the site order item rental discounted?|\r\n| ItemRentals[0].DiscountOverridePrice| The discount override price associated to the site order item rental.|\r\n| ItemRentals[0].DiscountReasonListItem| The GUID and description of the discount reason associated to site order item rental.|\r\n| ItemRentals[0].Guid| The GUID associated to the site order item rental.|\r\n| ItemRentals[0].IsDeleted| Whether the site order item rental is deleted.|\r\n| PermitRequired| Whether the site order has required permit.|\r\n| RelatedPriceGuidFilter| Used to filter by the related price GUID.|\r\n| RelatedPriceModifierGuidFilter| Used to filter by the related price modifier GUID.|\r\n| RelatedCostGuidFilter| Used to filter by the related cost GUID.|\r\n| AreaOfOriginListItem| The GUID and description of the area of origin associated to the site order.|\r\n| StandingJobs| The list of standing job template associated to the site order.|\r\n| StandingJobs[0].Guid| The GUID associated to the standing job template of site order.|\r\n| StandingJobs[0].ActionListItem| The GUID and description of the action associated to site order standing job|\r\n| StandingJobs[0].ContainerTypeListItem| The GUID and description of the containertype associated to site order standing job|\r\n| StandingJobs[0].EndOnJobCompletion| Is job completion on end for standing job|\r\n| StandingJobs[0].ExcludeNoBinOnSite| Exclude no bin on site for standing job|\r\n| StandingJobs[0].IsNoPlannedDay| Is on no planned day for standing job|\r\n| StandingJobs[0].PickupIntervalListItem| The GUID and description of the pickup interval associated to site order standing job|\r\n| StandingJobs[0].StartDate| The start date associated to the standing job.|\r\n| StandingJobs[0].EndDate| The end date associated to the standing job.|\r\n| StandingJobs[0].CompanyOutletListItem| The GUID and description of the companyoutlet associated to site order standing job|\r\n| StandingJobs[0].RelatedSiteAreaGuid| The GUID associated to the customer site area of the site order standing job.|\r\n| StandingJobs[0].DayOfWeekListItem| The GUID and description of the day of week associated to site order standing job|\r\n| StandingJobs[0].RelatedSysUserDriverGuid| The GUID associated to the sriver sysuser of the site order standing job.|\r\n| StandingJobs[0].RelatedVehicleGuid| The GUID associated to the vehcile of the site order standing job.|\r\n| StandingJobs[0].RequestedBy| Requested by details of standing job.|\r\n| StandingJobs[0].IsDeleted| Whether the standing job related to the siteorderis deleted.|\r\n| StandingJobsSiteAreaGuidFilter| Used to filter by the standing job site area guid.|\r\n| StandingJobsSysUserDriverGuidFilter| Used to filter by the standing job sysuser driver guid.|\r\n| StandingJobsVehicleGuidFilter| Used to filter by the standing job vehicle guid.|\r\n| StandingJobsStartDateFilter| Used to filter by the standing job start date.|\r\n| StandingJobsEndDateFilter| Used to filter by the standing job end date.|\r\n| InspectionTypeListItem| The GUID and description of the inspection type associated to the site order.|\r\n| ItemTimeStamp| The item timestamp of the site order.|\r\n| RouteAssignments| The list of route assignments associated to the site order.|\r\n| RouteAssignments[0].Guid| The guid associated to the route assignment.|\r\n| RouteAssignments[0].ActionListItem| The GUID and description of the action associated to site order route assignment|\r\n| RouteAssignments[0].ContainerTypeListItem| The GUID and description of the containertype associated to site order route assignment|\r\n| RouteAssignments[0].PickupIntervalListItem| The GUID and description of the pickup interval associated to site order route assignment|\r\n| RouteAssignments[0].DayOfWeekListItem| The GUID and description of the day of week associated to site order route assignment|\r\n| RouteAssignments[0].DayOfOccurrenceInMonthListItem| The GUID and description of the day of occurrence in month associated to site order route assignment|\r\n| RouteAssignments[0].Position| The position associated to the routeAssignment.|\r\n| RouteAssignments[0].StartDate| The start date associated to the route assignment in ISO format (YYYY-MM-DD).|\r\n| RouteAssignments[0].EndDate| The end date associated to the route assignment in ISO format (YYYY-MM-DD).|\r\n| RouteAssignments[0].RequestedBy| Who is the routeAssignment requested by?|\r\n| RouteAssignments[0].Notes| The notes associated to the routeAssignment.|\r\n| RouteAssignments[0].MaxLiftQuantity| The max lift quantity associated to the routeAssignment.|\r\n| RouteAssignments[0].MinLiftQuantity| The min lift quantity associated to the routeAssignment.|\r\n| RouteAssignments[0].RequiresQuantity| Does the routeAssignment require quantity?|\r\n| RouteAssignments[0].IsGpsAutoMatchingDisabled| Is the GPS auto matching disabled for the routeAssignment?|\r\n| RouteAssignments[0].IsNoPlannedDate| Is there no planned date for the routeAssignment?|\r\n| RouteAssignments[0].IsNoBinOnSiteExcluded| Is the bin on site excluded for the routeAssignment? |\r\n| RouteAssignments[0].RelatedRouteTemplateGuid| The guid associated to the route template to the routeAssignment.|\r\n| RouteAssignments[0].RelatedSiteAreaGuid| The guid associated to the site area of the route assignment.|\r\n| RouteAssignments[0].IsDeleted| Whether the site order route assignment is deleted.|\r\n| RouteAssignments[0].Exclusions| The list of exclusions associated to the route assignment.|\r\n| RouteAssignments[0].Exclusions[0].Guid| The guid associated to the exclusion.|\r\n| RouteAssignments[0].Exclusions[0].ExcludeFrom| The exclude from date associated to the exclusion.|\r\n| RouteAssignments[0].Exclusions[0].ExcludeTo| The exclude to date associated to the exclusion.|\r\n| RouteAssignments[0].Exclusions[0].ExclusionTypeListItem| The guid and description of the exclusion type associated to the exclusion.|\r\n| RouteAssignments[0].Exclusions[0].ReasonListItem| The guid and description of the reason associated to the exclusion.|\r\n| RouteAssignments[0].Exclusions[0].Notes| The notes associated to the exclusion.|\r\n| RouteCalloutRequests| The list of route callout requests associated to the site order.|\r\n| RouteCalloutRequests[0].Guid| The guid associated to the route callout request.|\r\n| RouteCalloutRequests[0].ActionListItem| The GUID and description of the action associated to site order route callout request|\r\n| RouteCalloutRequests[0].OutletListItem | The GUID and description of the company outlet associated to site order route callout request|\r\n| RouteCalloutRequests[0].ContainerTypeListItem| The GUID and description of the containertype associated to site order route callout request|\r\n| RouteCalloutRequests[0].DateRequired| The date required of the route callout request|\r\n| RouteCalloutRequests[0].Notes| The notes of the route callout request|\r\n| RouteCalloutRequests[0].RelatedRouteVisitGuid| The guid associated to the routevisit of the route callout request.|\r\n| RouteCalloutRequests[0].RequestedBy| Who requested the route callout request.|\r\n| RouteCalloutRequests[0].MaxLiftQuantity| The max lift quantity of the route callout request.|\r\n| RouteCalloutRequests[0].IsDeleted| Whether the route callout request is deleted.|\r\n| RouteAssignmentSiteAreaGuidFilter| Used to filter by the related route assignment site area GUID. |\r\n| RouteAssignmentStartDateFilter | Used to filter by the related route assignment start date|\r\n| RouteAssignmentEndDateFilter | Used to filter by the related route assignment end date|\r\n| RelatedContainerGuidFilter| Used to filter by the related container GUID.|\r\n| RelatedOrderCombinationGroupingGuid| The GUID associated to the order combination grouping. Filterable|\r\n| ContainersGeoLocationLatFilter| Used to filter by the location latitude of the site order item|\r\n| ContainersGeoLocationLongFilter| Used to filter by the location longitude of the site order item|\r\n| RelatedRouteVisitGuidFilter| Used to filter by the related routevisit GUID.|\r\n| RouteCalloutRequestGuidFilter| Used to filter by the route callout request GUID|"
operationId: Order_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[ApiIntegratorOrderResource]'
put:
tags:
- Order
summary: Partial update
description: "| Property| Description| Required |\r\n| ------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -------- |\r\n| GUID| The GUID associated to the site order.| No |\r\n| RelatedSiteGuid| The GUID associated to the customer site of the site order.| Yes |\r\n| RelatedSiteAreaGuid| The GUID associated to the customer site area of the site order.| No |\r\n| RelatedSupplierSiteForServiceGuid| The GUID associated to the supplier site for service of the site order.| No |\r\n| RelatedSupplierSiteForTransportGuid| The GUID associated to the supplier site for transport of the site order.| No |\r\n| RelatedUserSalesRepGuid| The GUID associated to the sales rep of the site order.| No | \r\n| RelatedServiceAgreementGuid| The GUID associated to the service agreement of the site order.| Yes |\r\n| RelatedPONumberChainGuid| The GUID associated to the purchase order number chain of the site order.| No |\r\n| OrderNumber| Used to filter the order number associated to the site order.| No |\r\n| CustomerOrderNumber| The customer order number associated to the site order.| No |\r\n| OrderedBy| The ordered by associated to the site order.| No |\r\n| ProcessFrom| The process from date associated to the site order in ISO format (YYYY-MM-DD).| Yes |\r\n| ValidUntil| The valid until date associated to the site order in ISO format (YYYY-MM-DD).| No |\r\n| Notes| The notes associated to the site order.| No |\r\n| DriverNotes| The driver notes associated to the site order.| No |\r\n| IsCustomerOwnedEquipment| Is the equipment used in the site order customer owned?| Yes |\r\n| CompanyOutletListItem| The GUID and description of the company outlet associated to the site order.| Yes |\r\n| ServiceListItem| The GUID and description of the service associated to the site order.| Yes |\r\n| MaterialListItem| The GUID and description of the material associated to the site order.| Yes |\r\n| DefaultContainerTypeListItem| The GUID and description of the container type associated to the site order.| No |\r\n| PriorityListItem| The GUID and description of the priority associated to the site order.| Yes |\r\n| PaymentTypeListItem| The GUID and description of the payment type associated to the site order.| No |\r\n| Containers[0]| The list of site order items associated to the site order.| No |\r\n| Containers[0].Guid| The GUID associated to the site order item.| Yes |\r\n| Containers[0].IsDeleted| Whether the site order item is deleted.| No |\r\n| Containers[0].Notes| The Notes associated to the site order item.| No |\r\n| Containers[0].IsContainerAssignedWithoutJob | Whether the container is assigned without job.| Yes |\r\n| Containers[0].IsFromIncreasedOrder | Whether the container is from increased order.| Yes |\r\n| Containers[0].IsContainerRemovedWithoutJob | Whether the container is removed without job.| Yes |\r\n| Containers[0].IsFixLocation | Whether the container has a fixed location.| No |\r\n| Containers[0].Geo | The Geo Location associated to the site order item.| No |\r\n| Containers[0].Geo.Location.Lat| The latitude of Geo Location associated to the site order item.| No |\r\n| Containers[0].Geo.Location.Long| The longitude of Geo Location associated to the site order item.| No |\r\n| Containers[0].StartDate | The StartDate associated to the site order item.| No |\r\n| Containers[0].EndDate| The EndDate associated to the site order item.| No |\r\n| Containers[0].DateLinked | The DateLinked associated to the site order item.| No |\r\n| Containers[0].RelatedContainerGuid| The GUID associated to the container of the site order item.| No |\r\n| Containers[0].ContainerTypeListItem| The GUID and description of the container type associated to site order item.| Yes |\r\n| Containers[0].ContainerStateListItem| The GUID and description of the site order item state associated to site order item.| Yes |\r\n| RelatedLocationDestinationGuid| The destination location associated to the site order. | Yes |\r\n| IsDeleted| Whether the site order is deleted.| No |\r\n| ItemRentals| The list of site order item rentals associated to
# --- truncated at 32 KB (110 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amcs-group/refs/heads/main/openapi/amcs-group-order-api-openapi.yml