SOAP Documentation: Purchase Orders

Overview

This resource provides methods to create, read, update and delete attribute data from the Purchase Order data collection object in a Supplier Compliance instance of TraceGains.

Operations List

The Operations List for this resource: Purchase Orders Operations List.

Resource WSDL

The WSDL for this resource can be found here: Purchase Orders WSDL.

Endpoint URLs

All requests should be sent to one of the following:
      Production Environment: https://api.tracegains.net/v7/soap/Pos.asmx.
      Test Environment: https://api-test.tracegains.net/v7/soap/Pos.asmx.

Delete

Enterprise | SC

 Deletes a PO data record by its ID.

The methods List or Query can be used to retrieve the IDs of PO data records.

Notes:

  • All documents for all line numbers assigned this PO will be deleted.

Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
poId Integer The ID of the PO data record to delete.

Response:
RequestResult The default response. This response can take on a different XML element name depending on the development IDE/toolset being used.

DeleteLine

Enterprise | SC

 Deletes a PO Line data record by the PO ID and the line number.

Notes:

  • You may not delete the last line of a Purchase Order using this method. To delete the last line of a Purchase Order delete the PO data record.
    Deleting the last line of a PO without deleting the PO header will orphan the PO header and remove the PO from the TraceGains UI!
  • All documents for this PO line number will be deleted.

Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
poId Integer The ID of the PO data record to delete.
lineNumber String The line number of the PO to delete.

Response:
RequestResult The default response. This response can take on a different XML element name depending on the development IDE/toolset being used.

List

Enterprise | SC

 Returns a paged list of PO data records using basic request parameters.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
fromModifiedDate DateTime ISO 8601 formatted date/time string in Coordinated Universal Time (UTC). Returns PO records that have been modified after this date and time.
toModifiedDate DateTime ISO 8601 formatted date/time string in Coordinated Universal Time (UTC). Returns PO records that have been modified before this date and time.
pagingCriteria PagingCriteria Row index paging criteria.
attributeType AttributeRequestType Determines what type of Attributes to return.

Response:

Element Type Description
ResponseCode ResponseCode A valid HTTP status code.
Message String A log friendly message.
Pos
repeating 		Po The list of returned PO data records.

Query

Enterprise | SC

 Returns a paged list of PO data records using more advanced request parameters.

Notes:

This method queries raw record data in your TraceGains instance using contains or partial match filtering for all attribute data provided in the filterValues parameter. This behavior is consistent with grid view filtering in the TraceGains UI and reduces the amount of calls to the method required to find similarly sequenced data.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
fromModifiedDate DateTime ISO 8601 formatted date/time string in Coordinated Universal Time (UTC). Returns PO records that have been modified after this date and time.
toModifiedDate DateTime ISO 8601 formatted date/time string in Coordinated Universal Time (UTC). Returns PO records that have been modified before this date and time.
pagingCriteria PagingCriteria Row index paging criteria.
attributeType AttributeRequestType Determines what type of Attributes to return.
filterValues
repeating		 AttributeValue A list of attribute-value pairs to filter returned PO data records. Attributes must be of type Po as defined in AttributeUseType. All others will be ignored.

Response:

Element Type Description
ResponseCode ResponseCode A valid HTTP status code.
Message String A log friendly message.
Pos
repeating 		Po The list of returned PO data records.

Upload

Enterprise | SC

 Creates/updates PO data records based on key attribute configuration.

This method will create or update existing PO data records based on the key attributes provided in the poData attribute list. It is recommend that all currently configured key attributes be included in each call to this method, or unexpected results could occur.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
poData
repeating		 AttributeValue A list of attribute-value pairs to add/update for the PO. Attributes must be of type Po as defined in AttributeUseType. All others will be ignored.

Response:
RequestResult The default response. This response can take on a different XML element name depending on the development IDE/toolset being used.

Version

 Reports the version information of this resource.


Request:

No Parameters


Response:

Element Type Description
ResponseCode ResponseCode A valid HTTP Status Code
Message String A log friendly message that can be used in troubleshooting a failed response.
Version String The major, minor, and build number of this resource.