GET api/v1/items/returns
Return a list of items returned (filtered by parameters).
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
issued_date_from |
Issued date from. Date in ISO-8601 format. Only date part (no time) is evaluated ('YYYY-MM-DD'). 'issued_date' interval or 'p_receipt_date' interval must be defined (maximum internal: 1 month). |
string |
None. |
issued_date_to |
Issued date to. Date in ISO-8601 format. Only date part (no time) is evaluated ('YYYY-MM-DD'). 'issued_date' interval or 'p_receipt_date' interval must be defined (maximum internal: 1 month). |
string |
None. |
p_receipt_date_from |
Package receipt date from. Date in ISO-8601 format. Only date part (no time) is evaluated ('YYYY-MM-DD'). 'issued_date' interval or 'p_receipt_date' interval must be defined. |
string |
None. |
p_receipt_date_to |
Package receipt date to. Date in ISO-8601 format. Only date part (no time) is evaluated ('YYYY-MM-DD'). 'issued_date' interval or 'p_receipt_date' interval must be defined. |
string |
None. |
return_type |
Return Type. Acceped values are: "R" (for RMA), "U" for Undeliverables or empty string (for all) |
string |
None. |
return_status |
Return Status. Acceped values are: "O" (for Open), "R" for Received or empty string (for all) |
string |
None. |
page |
Page number. |
integer |
Default value is 1 |
page_size |
Amount of items returned per page. Maximum is set to 500. |
integer |
Default value is 500 |
Body Parameters
None.
Response Information
Resource Description
response_get_items_returnsName | Description | Type | Additional information |
---|---|---|---|
error_code |
Zero if no errors. See 'error_message' for a detailed description of the error. |
integer |
None. |
error_message |
Returns a detailed description of the error. |
string |
None. |
returns |
List of items returned. |
Collection of item_return |
None. |
Response Formats
application/json, text/json
{ "error_code": 0, "error_message": "", "returns": [ { "rma_number": "300003", "return_type": "R", "issued_date": "2023-04-06", "issued_to": "Gmail GD #98 - Gmail GoDirect", "warehouse": "EX - ZCLC", "item_number": "LGX-10613", "item_description": "Blue Piston Wireless Bluetooth", "dcl_po_number": "2383332", "po_line_number": 1, "authorized_qty": 2, "received_qty": 2, "p_receipt_date": null, "i_receipt_date": "2023-04-11", "rma_type_reason": "Replace Upon Receipt", "condition_upon_receipt": "Box in good condition", "disposition": "Hold for Testing", "supplier_number": "119350", "serial_number": "", "dcl_item_number": "IMK1-LGX-10613", "transaction_originator": "JDE", "rma_code": "T01", "condition_code": "C1", "disposition_code": "D10", "original_order_number": "GDTEST000090", "comments": "", "receipt_package_reference": "" }, { "rma_number": "300003", "return_type": "R", "issued_date": "2023-04-06", "issued_to": "Gmail GD #98 - Gmail GoDirect", "warehouse": "EX - ZCLC", "item_number": "LGX-10624", "item_description": "Universal Folio for Tablets Up", "dcl_po_number": "2383332", "po_line_number": 2, "authorized_qty": 2, "received_qty": 2, "p_receipt_date": null, "i_receipt_date": "2023-04-11", "rma_type_reason": "Replace Upon Receipt", "condition_upon_receipt": "Box in good condition", "disposition": "Hold for Testing", "supplier_number": "119350", "serial_number": "SN943723729472", "dcl_item_number": "IMK1-LGX-10624", "transaction_originator": "JDE", "rma_code": "T01", "condition_code": "C1", "disposition_code": "D10", "original_order_number": "GDTEST000090", "comments": "", "receipt_package_reference": "" } ] }