1. Oracle Utilities REST API for Work and Asset
  2. Tasks
  3. Purchasing
  4. Vendor Location Synchronization

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
Request Body - application/xml ()
Root Schema : schema
Type: object
Show Source
Nested Schema : input
Type: object
Show Source
  • 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
  • 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
  • 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
Nested Schema : output
Type: object
Show Source
Nested Schema : vendorLocation
Type: object
Show Source
  • Maximum Length: 4
    Indicates that an invoice will be automatically created for the purchase order upon receipt.
    Example: W1YS
  • 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` - Yes
    Example: W1YS
  • 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
  • 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 Management
    Example: 2013-11-07T20:16:59-08:00
  • Maximum Length: 3
    Foreign Key (FK) to Currency Type
    Example: United States Dollars
  • 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 Allowed
    Example: W1AL
  • Maximum Length: 30
    Free on board code. This field is controlled by the Free on Board portal.
    Example: WD-OriginFreightCollected
  • location
  • Maximum Length: 254
    Location Name
    Example: Grainger San Jose
  • Indicates a dollar amount which is the minimum the vendor location will accept for one order.
    Example: 100
  • Allowed Values: [ "W1AL", "W1NA" ]
    Indicates whether or not the vendor location accepts orders.Order From: * `W1AL` - Allowed, * `W1NA` - Not Allowed
    Example: W1AL
  • 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
  • Allowed Values: [ "W1NO", "W1YS" ]
    Pay Tax To Vendor: * `W1NO` - No, * `W1YS` - Yes
    Example: W1YS
  • Allowed Values: [ "W1AL", "W1NA" ]
    Indicates whether or not the vendor location handles its own billing.Pay To: * `W1AL` - Allowed, * `W1NA` - Not Allowed
    Example: W1AL
  • Maximum Length: 60
    Identifier Value
    Example: 300000047414543
  • 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
  • Maximum Length: 12
    Status of the vendor based on business object lifecycle.
    Example: ACTIVE
  • 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
  • Maximum Length: 60
    Identifier Value
    Example: 300000047414503
  • Maximum Length: 60
    Identifier Value
    Example: 300000047414539
  • Maximum Length: 254
    Vendor Name
    Example: Grainger Supply
  • Maximum Length: 254
    Website of the vendor
    Example: http://www.xyz.com
Nested Schema : location
Type: object
Show Source
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : input
Type: object
Show Source
  • 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
  • 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
  • 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
Nested Schema : output
Type: object
Show Source
Nested Schema : vendorLocation
Type: object
Show Source
  • Maximum Length: 4
    Indicates that an invoice will be automatically created for the purchase order upon receipt.
    Example: W1YS
  • 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` - Yes
    Example: W1YS
  • 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
  • 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 Management
    Example: 2013-11-07T20:16:59-08:00
  • Maximum Length: 3
    Foreign Key (FK) to Currency Type
    Example: United States Dollars
  • 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 Allowed
    Example: W1AL
  • Maximum Length: 30
    Free on board code. This field is controlled by the Free on Board portal.
    Example: WD-OriginFreightCollected
  • location
  • Maximum Length: 254
    Location Name
    Example: Grainger San Jose
  • Indicates a dollar amount which is the minimum the vendor location will accept for one order.
    Example: 100
  • Allowed Values: [ "W1AL", "W1NA" ]
    Indicates whether or not the vendor location accepts orders.Order From: * `W1AL` - Allowed, * `W1NA` - Not Allowed
    Example: W1AL
  • 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
  • Allowed Values: [ "W1NO", "W1YS" ]
    Pay Tax To Vendor: * `W1NO` - No, * `W1YS` - Yes
    Example: W1YS
  • Allowed Values: [ "W1AL", "W1NA" ]
    Indicates whether or not the vendor location handles its own billing.Pay To: * `W1AL` - Allowed, * `W1NA` - Not Allowed
    Example: W1AL
  • Maximum Length: 60
    Identifier Value
    Example: 300000047414543
  • 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
  • Maximum Length: 12
    Status of the vendor based on business object lifecycle.
    Example: ACTIVE
  • 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
  • Maximum Length: 60
    Identifier Value
    Example: 300000047414503
  • Maximum Length: 60
    Identifier Value
    Example: 300000047414539
  • Maximum Length: 254
    Vendor Name
    Example: Grainger Supply
  • Maximum Length: 254
    Website of the vendor
    Example: http://www.xyz.com
Nested Schema : location
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Success response
Body ()
Root Schema : SYNCVENDORLOCATION_response
Type: object
Show Source
Nested Schema : W1VndLocSyn
Type: object
Show Source
Nested Schema : input
Type: object
Show Source
  • 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
  • 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
  • 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
Nested Schema : output
Type: object
Show Source
Nested Schema : vendorLocation
Type: object
Show Source
  • Maximum Length: 4
    Indicates that an invoice will be automatically created for the purchase order upon receipt.
    Example: W1YS
  • 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` - Yes
    Example: W1YS
  • 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
  • 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 Management
    Example: 2013-11-07T20:16:59-08:00
  • Maximum Length: 3
    Foreign Key (FK) to Currency Type
    Example: United States Dollars
  • 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 Allowed
    Example: W1AL
  • Maximum Length: 30
    Free on board code. This field is controlled by the Free on Board portal.
    Example: WD-OriginFreightCollected
  • location
  • Maximum Length: 254
    Location Name
    Example: Grainger San Jose
  • Indicates a dollar amount which is the minimum the vendor location will accept for one order.
    Example: 100
  • Allowed Values: [ "W1AL", "W1NA" ]
    Indicates whether or not the vendor location accepts orders.Order From: * `W1AL` - Allowed, * `W1NA` - Not Allowed
    Example: W1AL
  • 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
  • Allowed Values: [ "W1NO", "W1YS" ]
    Pay Tax To Vendor: * `W1NO` - No, * `W1YS` - Yes
    Example: W1YS
  • Allowed Values: [ "W1AL", "W1NA" ]
    Indicates whether or not the vendor location handles its own billing.Pay To: * `W1AL` - Allowed, * `W1NA` - Not Allowed
    Example: W1AL
  • Maximum Length: 60
    Identifier Value
    Example: 300000047414543
  • 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
  • Maximum Length: 12
    Status of the vendor based on business object lifecycle.
    Example: ACTIVE
  • 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
  • Maximum Length: 60
    Identifier Value
    Example: 300000047414503
  • Maximum Length: 60
    Identifier Value
    Example: 300000047414539
  • Maximum Length: 254
    Vendor Name
    Example: Grainger Supply
  • Maximum Length: 254
    Website of the vendor
    Example: http://www.xyz.com
Nested Schema : location
Type: object
Show Source

400 Response

Bad Request
Body ()
Root Schema : SYNCVENDORLOCATION_error
Type: object
Show Source
Nested Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.

500 Response

Internal Server Error
Body ()
Root Schema : SYNCVENDORLOCATION_error
Type: object
Show Source
Nested Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.
Back to Top