Synchronize Vendor Location
post
https://server:port/rest/apis/asset/purchasing/vendorLocationSynchronization/
This REST service synchronizes Enterprise Resource Planning (ERP) Suppliers with Work and Asset Management Vendor and Vendor Locations, by creating Work and Asset Management Vendor Location Data Synchronization objects.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Nested Schema : input
Type:
Show Source
object
-
externalReferenceId: string
Maximum Length:
36
Represents Enterprise Resource Planning's unique system-generated item ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.Example:300000047414539
-
externalSystem: string
Maximum Length:
30
The default value for the Enterprise Resource Planning Integration. You can retrieve the correct value from the property name wacs.externalsystem in the ERPWACS_ConfigProps file. This value must be defined for Work and Asset Management to function properly.Example:ERP
-
initialLoad: string
Maximum Length:
4
Indicates how the sync request is initiated by the external system, for example by a mass load like conversion.Example:F1IL
-
vendorLocation: object
vendorLocation
Nested Schema : output
Type:
Show Source
object
-
syncRequestId: string
(syncRequestId)Example:
24159624001247
Nested Schema : vendorLocation
Type:
Show Source
object
-
autoPay: string
Maximum Length:
4
Indicates that an invoice will be automatically created for the purchase order upon receipt.Example:W1YS
-
carrierFlag: string
Allowed Values:
[ "W1NO", "W1YS" ]
This indicates if the location provides shipping (for example referenced on purchase orders and purchase requests as a carrier.Carrier: * `W1NO` - No, * `W1YS` - YesExample:W1YS
-
carrierLocationId: string
Maximum Length:
12
This is the location used if the location does not provide shipping. This field is required if Carrier Flag is set to No, otherwise, should not be populated.Example:691714579103
-
creationDateTime: string
(date-time)
The creation date and time of the vendor location. If left blank, it is defaulted to system date and time when it is created in Work and Asset ManagementExample:
2013-11-07T20:16:59-08:00
-
currency: string
Maximum Length:
3
Foreign Key (FK) to Currency TypeExample:United States Dollars
-
emailPoFlag: string
Allowed Values:
[ "W1AL", "W1NA" ]
Indicates whether or not purchase orders should be emailed to this vendor location. After the purchase order is issued, an option becomes available under Additional Processes to email the order.Email PO: * `W1AL` - Allowed, * `W1NA` - Not AllowedExample:W1AL
-
fob: string
Maximum Length:
30
Free on board code. This field is controlled by the Free on Board portal.Example:WD-OriginFreightCollected
-
location: object
location
-
locationName: string
Maximum Length:
254
Location NameExample:Grainger San Jose
-
minimumOrderAmount: number
Indicates a dollar amount which is the minimum the vendor location will accept for one order.Example:
100
-
orderFromFlag: string
Allowed Values:
[ "W1AL", "W1NA" ]
Indicates whether or not the vendor location accepts orders.Order From: * `W1AL` - Allowed, * `W1NA` - Not AllowedExample:W1AL
-
paymentTerm: string
Maximum Length:
30
Indicates the terms for paying the vendor such as Net 30. This field is controlled by the Payment Terms portal.Example:Net 30
-
payTaxToVendor: string
Allowed Values:
[ "W1NO", "W1YS" ]
Pay Tax To Vendor: * `W1NO` - No, * `W1YS` - YesExample:W1YS
-
payToFlag: string
Allowed Values:
[ "W1AL", "W1NA" ]
Indicates whether or not the vendor location handles its own billing.Pay To: * `W1AL` - Allowed, * `W1NA` - Not AllowedExample:W1AL
-
payToVendorLocationExternalId: string
Maximum Length:
60
Identifier ValueExample:300000047414543
-
poEmailAddress: string
Maximum Length:
70
The email address where purchase orders should be sent for this location. This is required if Email PO is allowed.Example:xyz@domain.com
-
status: string
Maximum Length:
12
Status of the vendor based on business object lifecycle.Example:ACTIVE
-
vendor: string
Maximum Length:
30
Unique identification for the vendor in Work and Asset Management. When vendor location(s) of a new vendor are synced into Work and Asset Management for the first time, a new vendor record is created with this as its primary key in the Vendor portal. This could be different from the unique identifier of the vendor in the external system.Example:XYZ
-
vendorExternalId: string
Maximum Length:
60
Identifier ValueExample:300000047414503
-
vendorLocationExternalId: string
Maximum Length:
60
Identifier ValueExample:300000047414539
-
vendorName: string
Maximum Length:
254
Vendor NameExample:Grainger Supply
-
website: string
Maximum Length:
254
Website of the vendorExample:http://www.xyz.com
Nested Schema : location
Type:
Show Source
object
-
address1: string
Maximum Length:
254
Vendor Address Line 1Example:5000 CARTER DR
-
address2: string
Maximum Length:
254
Vendor Address Line 2 -
address3: string
Maximum Length:
254
Vendor Address Line 3 -
address4: string
Maximum Length:
254
Vendor Address Line 4 -
city: string
Maximum Length:
90
Vendor CityExample:LOS ANGELES
-
country: string
Maximum Length:
3
Vendor CountryExample:US
-
county: string
Maximum Length:
90
Vendor CountyExample:LOS ANGELES
-
crossStreet: string
Maximum Length:
64
Vendor Cross Street -
geographicCode: string
Maximum Length:
11
Vendor Geographical Code -
houseType: string
Vendor House TypeHouse Type:
-
inCityLimit: boolean
Vendor In City Limit
-
number1: string
Maximum Length:
6
Vendor Address Number 1 -
number2: string
Maximum Length:
4
Vendor Address Number 2 -
postal: string
Maximum Length:
12
Vendor PostalExample:90032
-
state: string
Maximum Length:
6
Vendor StateExample:CA
-
suburb: string
Maximum Length:
64
Vendor Suburb
Nested Schema : input
Type:
Show Source
object
-
externalReferenceId: string
Maximum Length:
36
Represents Enterprise Resource Planning's unique system-generated item ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.Example:300000047414539
-
externalSystem: string
Maximum Length:
30
The default value for the Enterprise Resource Planning Integration. You can retrieve the correct value from the property name wacs.externalsystem in the ERPWACS_ConfigProps file. This value must be defined for Work and Asset Management to function properly.Example:ERP
-
initialLoad: string
Maximum Length:
4
Indicates how the sync request is initiated by the external system, for example by a mass load like conversion.Example:F1IL
-
vendorLocation: object
vendorLocation
Nested Schema : output
Type:
Show Source
object
-
syncRequestId: string
(syncRequestId)Example:
24159624001247
Nested Schema : vendorLocation
Type:
Show Source
object
-
autoPay: string
Maximum Length:
4
Indicates that an invoice will be automatically created for the purchase order upon receipt.Example:W1YS
-
carrierFlag: string
Allowed Values:
[ "W1NO", "W1YS" ]
This indicates if the location provides shipping (for example referenced on purchase orders and purchase requests as a carrier.Carrier: * `W1NO` - No, * `W1YS` - YesExample:W1YS
-
carrierLocationId: string
Maximum Length:
12
This is the location used if the location does not provide shipping. This field is required if Carrier Flag is set to No, otherwise, should not be populated.Example:691714579103
-
creationDateTime: string
(date-time)
The creation date and time of the vendor location. If left blank, it is defaulted to system date and time when it is created in Work and Asset ManagementExample:
2013-11-07T20:16:59-08:00
-
currency: string
Maximum Length:
3
Foreign Key (FK) to Currency TypeExample:United States Dollars
-
emailPoFlag: string
Allowed Values:
[ "W1AL", "W1NA" ]
Indicates whether or not purchase orders should be emailed to this vendor location. After the purchase order is issued, an option becomes available under Additional Processes to email the order.Email PO: * `W1AL` - Allowed, * `W1NA` - Not AllowedExample:W1AL
-
fob: string
Maximum Length:
30
Free on board code. This field is controlled by the Free on Board portal.Example:WD-OriginFreightCollected
-
location: object
location
-
locationName: string
Maximum Length:
254
Location NameExample:Grainger San Jose
-
minimumOrderAmount: number
Indicates a dollar amount which is the minimum the vendor location will accept for one order.Example:
100
-
orderFromFlag: string
Allowed Values:
[ "W1AL", "W1NA" ]
Indicates whether or not the vendor location accepts orders.Order From: * `W1AL` - Allowed, * `W1NA` - Not AllowedExample:W1AL
-
paymentTerm: string
Maximum Length:
30
Indicates the terms for paying the vendor such as Net 30. This field is controlled by the Payment Terms portal.Example:Net 30
-
payTaxToVendor: string
Allowed Values:
[ "W1NO", "W1YS" ]
Pay Tax To Vendor: * `W1NO` - No, * `W1YS` - YesExample:W1YS
-
payToFlag: string
Allowed Values:
[ "W1AL", "W1NA" ]
Indicates whether or not the vendor location handles its own billing.Pay To: * `W1AL` - Allowed, * `W1NA` - Not AllowedExample:W1AL
-
payToVendorLocationExternalId: string
Maximum Length:
60
Identifier ValueExample:300000047414543
-
poEmailAddress: string
Maximum Length:
70
The email address where purchase orders should be sent for this location. This is required if Email PO is allowed.Example:xyz@domain.com
-
status: string
Maximum Length:
12
Status of the vendor based on business object lifecycle.Example:ACTIVE
-
vendor: string
Maximum Length:
30
Unique identification for the vendor in Work and Asset Management. When vendor location(s) of a new vendor are synced into Work and Asset Management for the first time, a new vendor record is created with this as its primary key in the Vendor portal. This could be different from the unique identifier of the vendor in the external system.Example:XYZ
-
vendorExternalId: string
Maximum Length:
60
Identifier ValueExample:300000047414503
-
vendorLocationExternalId: string
Maximum Length:
60
Identifier ValueExample:300000047414539
-
vendorName: string
Maximum Length:
254
Vendor NameExample:Grainger Supply
-
website: string
Maximum Length:
254
Website of the vendorExample:http://www.xyz.com
Nested Schema : location
Type:
Show Source
object
-
address1: string
Maximum Length:
254
Vendor Address Line 1Example:5000 CARTER DR
-
address2: string
Maximum Length:
254
Vendor Address Line 2 -
address3: string
Maximum Length:
254
Vendor Address Line 3 -
address4: string
Maximum Length:
254
Vendor Address Line 4 -
city: string
Maximum Length:
90
Vendor CityExample:LOS ANGELES
-
country: string
Maximum Length:
3
Vendor CountryExample:US
-
county: string
Maximum Length:
90
Vendor CountyExample:LOS ANGELES
-
crossStreet: string
Maximum Length:
64
Vendor Cross Street -
geographicCode: string
Maximum Length:
11
Vendor Geographical Code -
houseType: string
Vendor House TypeHouse Type:
-
inCityLimit: boolean
Vendor In City Limit
-
number1: string
Maximum Length:
6
Vendor Address Number 1 -
number2: string
Maximum Length:
4
Vendor Address Number 2 -
postal: string
Maximum Length:
12
Vendor PostalExample:90032
-
state: string
Maximum Length:
6
Vendor StateExample:CA
-
suburb: string
Maximum Length:
64
Vendor Suburb
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Nested Schema : input
Type:
Show Source
object
-
externalReferenceId: string
Maximum Length:
36
Represents Enterprise Resource Planning's unique system-generated item ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.Example:300000047414539
-
externalSystem: string
Maximum Length:
30
The default value for the Enterprise Resource Planning Integration. You can retrieve the correct value from the property name wacs.externalsystem in the ERPWACS_ConfigProps file. This value must be defined for Work and Asset Management to function properly.Example:ERP
-
initialLoad: string
Maximum Length:
4
Indicates how the sync request is initiated by the external system, for example by a mass load like conversion.Example:F1IL
-
vendorLocation: object
vendorLocation
Nested Schema : output
Type:
Show Source
object
-
syncRequestId: string
(syncRequestId)Example:
24159624001247
Nested Schema : vendorLocation
Type:
Show Source
object
-
autoPay: string
Maximum Length:
4
Indicates that an invoice will be automatically created for the purchase order upon receipt.Example:W1YS
-
carrierFlag: string
Allowed Values:
[ "W1NO", "W1YS" ]
This indicates if the location provides shipping (for example referenced on purchase orders and purchase requests as a carrier.Carrier: * `W1NO` - No, * `W1YS` - YesExample:W1YS
-
carrierLocationId: string
Maximum Length:
12
This is the location used if the location does not provide shipping. This field is required if Carrier Flag is set to No, otherwise, should not be populated.Example:691714579103
-
creationDateTime: string
(date-time)
The creation date and time of the vendor location. If left blank, it is defaulted to system date and time when it is created in Work and Asset ManagementExample:
2013-11-07T20:16:59-08:00
-
currency: string
Maximum Length:
3
Foreign Key (FK) to Currency TypeExample:United States Dollars
-
emailPoFlag: string
Allowed Values:
[ "W1AL", "W1NA" ]
Indicates whether or not purchase orders should be emailed to this vendor location. After the purchase order is issued, an option becomes available under Additional Processes to email the order.Email PO: * `W1AL` - Allowed, * `W1NA` - Not AllowedExample:W1AL
-
fob: string
Maximum Length:
30
Free on board code. This field is controlled by the Free on Board portal.Example:WD-OriginFreightCollected
-
location: object
location
-
locationName: string
Maximum Length:
254
Location NameExample:Grainger San Jose
-
minimumOrderAmount: number
Indicates a dollar amount which is the minimum the vendor location will accept for one order.Example:
100
-
orderFromFlag: string
Allowed Values:
[ "W1AL", "W1NA" ]
Indicates whether or not the vendor location accepts orders.Order From: * `W1AL` - Allowed, * `W1NA` - Not AllowedExample:W1AL
-
paymentTerm: string
Maximum Length:
30
Indicates the terms for paying the vendor such as Net 30. This field is controlled by the Payment Terms portal.Example:Net 30
-
payTaxToVendor: string
Allowed Values:
[ "W1NO", "W1YS" ]
Pay Tax To Vendor: * `W1NO` - No, * `W1YS` - YesExample:W1YS
-
payToFlag: string
Allowed Values:
[ "W1AL", "W1NA" ]
Indicates whether or not the vendor location handles its own billing.Pay To: * `W1AL` - Allowed, * `W1NA` - Not AllowedExample:W1AL
-
payToVendorLocationExternalId: string
Maximum Length:
60
Identifier ValueExample:300000047414543
-
poEmailAddress: string
Maximum Length:
70
The email address where purchase orders should be sent for this location. This is required if Email PO is allowed.Example:xyz@domain.com
-
status: string
Maximum Length:
12
Status of the vendor based on business object lifecycle.Example:ACTIVE
-
vendor: string
Maximum Length:
30
Unique identification for the vendor in Work and Asset Management. When vendor location(s) of a new vendor are synced into Work and Asset Management for the first time, a new vendor record is created with this as its primary key in the Vendor portal. This could be different from the unique identifier of the vendor in the external system.Example:XYZ
-
vendorExternalId: string
Maximum Length:
60
Identifier ValueExample:300000047414503
-
vendorLocationExternalId: string
Maximum Length:
60
Identifier ValueExample:300000047414539
-
vendorName: string
Maximum Length:
254
Vendor NameExample:Grainger Supply
-
website: string
Maximum Length:
254
Website of the vendorExample:http://www.xyz.com
Nested Schema : location
Type:
Show Source
object
-
address1: string
Maximum Length:
254
Vendor Address Line 1Example:5000 CARTER DR
-
address2: string
Maximum Length:
254
Vendor Address Line 2Example: -
address3: string
Maximum Length:
254
Vendor Address Line 3Example: -
address4: string
Maximum Length:
254
Vendor Address Line 4Example: -
city: string
Maximum Length:
90
Vendor CityExample:LOS ANGELES
-
country: string
Maximum Length:
3
Vendor CountryExample:US
-
county: string
Maximum Length:
90
Vendor CountyExample:LOS ANGELES
-
crossStreet: string
Maximum Length:
64
Vendor Cross StreetExample: -
geographicCode: string
Maximum Length:
11
Vendor Geographical CodeExample: -
houseType: string
Vendor House TypeHouse Type:Example:
-
inCityLimit: boolean
Vendor In City LimitExample:
-
number1: string
Maximum Length:
6
Vendor Address Number 1Example: -
number2: string
Maximum Length:
4
Vendor Address Number 2Example: -
postal: string
Maximum Length:
12
Vendor PostalExample:90032
-
state: string
Maximum Length:
6
Vendor StateExample:CA
-
suburb: string
Maximum Length:
64
Vendor SuburbExample:
400 Response
Bad Request
Nested Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format 'A/message/X/Y' where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.
500 Response
Internal Server Error
Nested Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format 'A/message/X/Y' where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.