API Search CR returns CR listing information generated from orders from the merchant.

URL

https://tikinowapi.tiki.vn/aftersales/2.0/customer_return/search

Link Production

METHOD

GET

QUERY HEADERS

Header	Value	Note
Content-Type	application/json
Authorization	Bearer <access_token>	access_token is generated by authorizing the In-House application of the Tiki Developer Platform

QUERY PARAMS

Params	Data Type	Required	Default Value	Description
limit	integer	N	10	Number of results to return per page.
offset	integer	N	0	The initial index from which to return the results.
ordering	string	N		Which field from to use when ordering the results: created_at|order_completed_at|completed_at.
search	string	N		Search by code, order code, customer name, customer email, customer phone
code__in	string	N		The list of CR Codes is concatenated with a “__” sign. For example: CRV23584795382, CRV23584795382__CRV22984471858
status__in	string	N		Search by status is concatenated with a “__” sign. For example: approved, approved__refunded
order_code__in	string	N		The list of Order Codes is concatenated with a “__” sign. For example: 983267726, 983267726__689956287
external_order_code__in	string	N		The list of Partner Order Codes is connected by a “__” sign. Example: SON00964, SON00964__SON00965
product_sku__in	string	N		The list of Product SKUs are joined by a “__” sign. For example: 7673492521341, 7673492521341__7673492521342
tnsl_client_code	string	N		TNSL partner code
tnsl_ref_code	string	N		Return code of TNSL partner
customer_id	integer	N		Search by customer’s ID
customer_name__contains	string	N		Search by customer name
customer_email__contains	string	N		Search by customer email
customer_phone__contains	string	N		Search by customer phone
return_method	string	N		Search by return method: TIKI, SELLER_DELIVERY, NO_PICKUP, TNSL_EXTERNAL
return_option	string	N		Search by return option (for return method is TIKI): customer_dropoff | tiki_pickup
order_completed_at__gte	datetime	N		Order completed time is greater than or equal to
order_completed_at__lte	datetime	N		Order completed time is less than or equal to
created_at__gte	datetime	N		CR created time is greater than or equal to
created_at__lte	datetime	N		CR created time is less than or equal to
completed_at__gte	datetime	N		CR completed time is greater than or equal to
completed_at__lte	datetime	N		CR completed time is less than or equal to

RESPONSE

Params	Type	Required	Description
count	integer	Y	Số lượng records
next	string	N	URL để lấy kết quả page tiếp theo
previous	string	N	URL để lấy kết quả page trước
results	array	Y	Danh sách records
results[].code	string	Y	CR Code. Ví dụ: CRV22993281276
results[].return_method	string	Y	Phương thức đổi trả
results[].return_method_displayed	string	Y	Tên phương thức đổi trả
results[].return_option	string	Y	Lựa chọn thu hồi
results[].return_option_displayed	string	Y	Tên lựa chọn thu hồi
results[].pickup_address	Object	Y	Thông tin địa chỉ lấy hàng
results[].customer	Object	Y	Thông tin khách hàng
results[].note	string	N	Ghi chú
results[].arrived_at_destination_date	Datetime	N	Thông tin thời gian vận chuyển đến đích
results[].status	string	Y	Trạng thái của CR
results[].status_displayed	string	Y	Tên trạng thái của CR
results[].tnsl_ref_code	string	N	Mã đổi trả của đối tác TNSL
results[].tnsl_client_code	string	N	Mã của đối tác TNSL
results[].created_at	Datetime	Y	Ngày tạo CR
results[].created_by	Object	Y	Thông tin người tạo CR
results[].approved_by	Object	Y	Thông tin người duyệt CR
results[].items	Array	Y	Danh sách Thông tin Sản phẩm đổi trả
results[].order	Object	Y	Thông tin đơn hàng

Thông tin results[].order

Params	Type	Required	Description
order_code	string	Y	Mã đơn hàng
order_id	integer	N	ID của đơn hàng
order_type	string	N	Loại đơn hàng:
order_created_at	Datetime	N	Ngày tạo đơn hàng
order_completed_at	Datetime	Y	Ngày hoàn thành đơn hàng
fulfillment_type	string	Y	Loại fulfillment_type: TIKI_DELIVERY: TIKI giao hàng SELLER_DELIVERY: Seller giao hàng DROPSHIP: Đơn hàng Dropship CROSS_BORDER: Đơn hàng Cross Border
inventory_status	string	Y	Trạng thái tồn kho
payment_method	string	N	Phương thức thanh toán
customer	Object	Y	Thông tin khách hàng
seller_info	Object	Y	Thông tin người bán
status	string	N	Trạng thái đơn hàng

Thông tin results[].items

Params	Type	Required	Description
id	integer	N
item_type	string	Y	Loại item:order_fee: Phí của đơn hàngorder_product: Sản phẩm của đơn hàng
item_type_displayed	string	Y	Hiện thị loại item
fee_type	string	N	Loại phí (Required if item_type = order_fee): shipping_fee: Phí giao hàng handling_fee: Phí xử lý installment_fee: Phí trả góp
fee_type_displayed	string	N	Hiển thị loại phí
product_sku	string	N	SKU của sản phẩm
qty_requested	integer	Y	Số lượng yêu cầu đổi trả
refund_amount	integer	Y	Số tiền hoàn trả
resolution_type	string	Y	Loại giải pháp khách hàng mong muốn: PICKUP_ONLY: Chỉ thu hồi vật lý
resolution_type_displayed	string	Y	Hiển thị loại giải pháp khách hàng mong muốn
order_line	Object	N	Thông tin sản phẩm đã mua
images	array	Y	Thông tin hình ảnh đã upload
return_reason	Object	Y	Lý do đổi trả
note	string	N	Ghi chú
status	string	Y	Trạng thái sản phẩm đổi trả
status_displayed	string	Y	Hiển thị trạng thái sản phẩm đổi trả
created_at	Datetime	N	Thời gian tạo
updated_at	Datetime	N	Thời gian cập nhật
ams_version	string	Y	Version của CR: ams_v1: AMS Version 1 ams_v2: AMS Version 2

Thông tin lý do đổi trả: items[].return_reason

Params	Type	Required	Description
code	string	Y	Mã code
name	string	Y	Tiêu đề
description	string	N	Mô tả