Service Directory > v32.1 > Inventory > Get_Goods_Delivery_Tickets
 

Operation: Get_Goods_Delivery_Tickets

This service operation will get Goods Delivery Tickets for the specified criteria.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Get_Goods_Delivery_Tickets_Request

Contains request reference, criteria, filter and response group for getting goods delivery ticket data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Goods_Delivery_Ticket_Request_References  [0..1]  Element containing reference instances for goods delivery ticket   
Request_Criteria [Choice]   Goods_Delivery_Ticket_Request_Criteria  [0..1]  Utilize the following element to find goods delivery tickets in the Workday system.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Goods_Delivery_Ticket_Response_Group  [0..1]  Goods Delivery Ticket Response Group   
top
 

Response Element: Get_Goods_Delivery_Tickets_Response

Get Goods Delivery Tickets Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Goods_Delivery_Ticket_Request_References  [0..*]  Get Goods Delivery Ticket Request References   
Request_Criteria  Goods_Delivery_Ticket_Request_Criteria  [0..*]  Goods Delivery Ticket Request Criteria   
Response_Filter  Response_Filter  [0..*]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Goods_Delivery_Ticket_Response_Group  [0..*]  Goods Delivery Ticket Response Group   
Response_Results  Response_Results  [0..*]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Goods_Delivery_Ticket_Response_Data  [0..*]  Goods Delivery Ticket Response Data   
top
 

Goods_Delivery_Ticket_Request_References

part of: Get_Goods_Delivery_Tickets_Request, Get_Goods_Delivery_Tickets_Response
Element containing reference instances for goods delivery ticket
 
Parameter name Type/Value Cardinality Description Validations
Goods_Delivery_Ticket_Request_Reference  Goods_DeliveryObject  [1..*]  Goods Delivery Ticket Request References   
top
 

Goods_DeliveryObject

part of: Goods_Delivery_Ticket_Request_References, Goods_Delivery_Ticket
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Goods_DeliveryObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Goods_DeliveryObjectID

part of: Goods_DeliveryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Good_Delivery_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Goods_Delivery_Ticket_Request_Criteria

part of: Get_Goods_Delivery_Tickets_Request, Get_Goods_Delivery_Tickets_Response
Utilize the following element to find goods delivery tickets in the Workday system.
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [0..1]  Company for Goods Delivery Ticket   
Goods_Delivery_Ticket_ID  string (513)   [0..1]  Goods Delivery Ticket ID   
Delivery_Ticket_Created_On_or_After  date  [0..1]  Goods Delivery Ticket created on or after date   
Delivery_Ticket_Created_On_or_Before  date  [0..1]  Goods Delivery Ticket created on or before date   
Delivery_Ticket_Status_Reference  Document_StatusObject  [0..*]  Goods Delivery Ticket Status   
Deliver_To_Location_Reference  LocationObject  [0..*]  Deliver-To location reference to Goods Delivery Ticket   
Created_By_Worker_Reference  WorkerObject  [0..*]  Created By Worker   
Requester_Worker_Reference  WorkerObject  [0..1]  Requester Reference   
Delivery_Ticket_Origin_Reference  Inventory_Stock_Request_OriginObject  [0..1]  Reference to Goods Delivery Ticket Origin   
top
 

CompanyObject

part of: Goods_Delivery_Ticket_Request_Criteria
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  CompanyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CompanyObjectID

part of: CompanyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Reference_ID, Organization_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Document_StatusObject

part of: Goods_Delivery_Ticket_Request_Criteria
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Document_StatusObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Document_StatusObjectID

part of: Document_StatusObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Document_Status_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

LocationObject

part of: Goods_Delivery_Ticket_Request_Criteria, Goods_Delivery_Ticket_outbound_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  LocationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

LocationObjectID

part of: LocationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Location_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

WorkerObject

part of: Goods_Delivery_Ticket_Request_Criteria, Goods_Delivery_Ticket_Request_Criteria, Goods_Delivery_Ticket_outbound_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  WorkerObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

WorkerObjectID

part of: WorkerObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Contingent_Worker_ID, Employee_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Inventory_Stock_Request_OriginObject

part of: Goods_Delivery_Ticket_Request_Criteria, Goods_Delivery_Ticket_outbound_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Inventory_Stock_Request_OriginObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Inventory_Stock_Request_OriginObjectID

part of: Inventory_Stock_Request_OriginObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Stock_Request_Origin_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Response_Filter

part of: Get_Goods_Delivery_Tickets_Request, Get_Goods_Delivery_Tickets_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Goods_Delivery_Ticket_Response_Group

part of: Get_Goods_Delivery_Tickets_Request, Get_Goods_Delivery_Tickets_Response
Element containing goods delivery ticket response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Goods_Delivery_Tickets_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Goods_Delivery_Ticket_Response_Data

part of: Get_Goods_Delivery_Tickets_Response
Get Goods Delivery Ticket Response Data
 
Parameter name Type/Value Cardinality Description Validations
Goods_Delivery_Ticket  Goods_Delivery_Ticket  [0..*]  Goods Delivery Ticket   
top
 

Goods_Delivery_Ticket

part of: Goods_Delivery_Ticket_Response_Data
Get Goods Delivery Ticket Response Data
 
Parameter name Type/Value Cardinality Description Validations
Goods_Delivery_Ticket_Reference  Goods_DeliveryObject  [0..1]  Goods Delivery Ticket   
Goods_Delivery_Ticket_Data  Goods_Delivery_Ticket_outbound_Data  [0..*]  Goods Delivery Ticket Data   
top
 

Goods_Delivery_Ticket_outbound_Data

part of: Goods_Delivery_Ticket
Element containing all Goods Delivery Tickets data.
 
Parameter name Type/Value Cardinality Description Validations
Goods_Delivery_Ticket_ID  string  [0..1]  ID   
Deliver_To_Location_Reference  LocationObject  [0..1]  Deliver-To Location   
Goods_Delivery_Ticket_Origin_Reference  Inventory_Stock_Request_OriginObject  [0..1]  Goods Delivery Ticket Origin   
Just_In_Time  boolean  [0..1]  Just in Time   
Requester_Reference  WorkerObject  [0..1]  Requester   
Goods_Delivery_Ticket_Line_Data  Goods_Delivery_Line_outbound_Data  [0..*]  Goods Delivery Ticket Line Data   
top
 

Goods_Delivery_Line_outbound_Data

part of: Goods_Delivery_Ticket_outbound_Data
Element containing all Goods Delivery Ticket Line data. Goods Delivery Ticket can have multiple lines
 
Parameter name Type/Value Cardinality Description Validations
Goods_Delivery_Line_Reference  Goods_Delivery_LineObject  [0..1]  Goods Delivery Line   
Goods_Delivery_Line_Number  decimal (4, 0) >0   [0..1]  Goods Delivery Line Number   
Item_Reference  Item_DescriptorObject  [0..1]  Delivery Item   
Item_Description  string  [0..1]  Item Description   
Unit_of_Measure_Reference  Unit_of_MeasureObject  [0..1]  Delivery Item Unit of Measure   
Quantity  decimal (22, 2)   [0..1]  Requested Quantity   
top
 

Goods_Delivery_LineObject

part of: Goods_Delivery_Line_outbound_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Goods_Delivery_LineObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Goods_Delivery_LineObjectID

part of: Goods_Delivery_LineObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Goods_Delivery_Line_Number  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Good_Delivery_ID, Goods_Delivery_Run_ID  [1..1]  The unique identifier type of a parent object   
top
 

Item_DescriptorObject

part of: Goods_Delivery_Line_outbound_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Item_DescriptorObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Item_DescriptorObjectID

part of: Item_DescriptorObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Catalog_Item_ID, Catalog_Load_Item_ID, Expense_Item_ID, Purchase_Item_ID, Sales_Item_ID, Supplier_Item_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Unit_of_MeasureObject

part of: Goods_Delivery_Line_outbound_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Unit_of_MeasureObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unit_of_MeasureObjectID

part of: Unit_of_MeasureObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, UN_CEFACT_Common_Code_ID, UOM_EDI_Code_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Goods_DeliveryReferenceEnumeration

part of: Goods_DeliveryObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Document_StatusReferenceEnumeration

part of: Document_StatusObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Inventory_Stock_Request_OriginReferenceEnumeration

part of: Inventory_Stock_Request_OriginObjectID
Base Type
string
top
 

Goods_Delivery_LineReferenceEnumeration

part of: Goods_Delivery_LineObjectID
Base Type
string
top
 

Base Type
string

top
 

Item_DescriptorReferenceEnumeration

part of: Item_DescriptorObjectID
Base Type
string
top
 

Unit_of_MeasureReferenceEnumeration

part of: Unit_of_MeasureObjectID
Base Type
string
top