1. Home
  2. Docs
  3. TikiNOW Smart Logistics
  4. API References
  5. Aftersales Service Group
  6. API Search CR

API Search CR

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

HeaderValueNote
Content-Typeapplication/json
AuthorizationBearer <access_token>access_token is generated by authorizing the In-House application of the Tiki Developer Platform

QUERY PARAMS

ParamsData TypeRequiredDefault ValueDescription
limitintegerN10Number of results to return per page.
offsetintegerN0The initial index from which to return the results.
orderingstringNWhich field from to use when ordering the results: created_at|order_completed_at|completed_at.
searchstringNSearch by code, order code, customer name, customer email, customer phone
code__instringNThe list of CR Codes is concatenated with a “__” sign. For example: CRV23584795382, CRV23584795382__CRV22984471858
status__instringNSearch by status is concatenated with a “__” sign. For example: approved, approved__refunded
order_code__instringNThe list of Order Codes is concatenated with a “__” sign. For example: 983267726, 983267726__689956287
external_order_code__instringNThe list of Partner Order Codes is connected by a “__” sign. Example: SON00964, SON00964__SON00965
product_sku__instringNThe list of Product SKUs are joined by a “__” sign. For example: 7673492521341, 7673492521341__7673492521342
tnsl_client_codestringNTNSL partner code
tnsl_ref_codestringNReturn code of TNSL partner
customer_idintegerNSearch by customer’s ID
customer_name__containsstringNSearch by customer name
customer_email__containsstringNSearch by customer email
customer_phone__containsstringNSearch by customer phone
return_methodstringNSearch by return method: TIKI, SELLER_DELIVERY, NO_PICKUP, TNSL_EXTERNAL
return_optionstringNSearch by return option (for return method is TIKI): customer_dropoff | tiki_pickup
order_completed_at__gtedatetimeNOrder completed time is greater than or equal to
order_completed_at__ltedatetimeNOrder completed time is less than or equal to
created_at__gtedatetimeNCR created time is greater than or equal to
created_at__ltedatetimeNCR created time is less than or equal to
completed_at__gtedatetimeNCR completed time is greater than or equal to
completed_at__ltedatetimeNCR completed time is less than or equal to

RESPONSE

ParamsTypeRequiredDescription
countintegerYSố lượng records
nextstringNURL để lấy kết quả page tiếp theo
previousstringNURL để lấy kết quả page trước
resultsarrayYDanh sách records
results[].codestringYCR Code. Ví dụ: CRV22993281276
results[].return_methodstringYPhương thức đổi trả
results[].return_method_displayedstringYTên phương thức đổi trả
results[].return_optionstringYLựa chọn thu hồi
results[].return_option_displayedstringYTên lựa chọn thu hồi
results[].pickup_addressObjectYThông tin địa chỉ lấy hàng
results[].customerObjectYThông tin khách hàng
results[].notestringNGhi chú
results[].arrived_at_destination_dateDatetimeNThông tin thời gian vận chuyển đến đích
results[].statusstringYTrạng thái của CR
results[].status_displayedstringYTên trạng thái của CR
results[].tnsl_ref_codestringNMã đổi trả của đối tác TNSL
results[].tnsl_client_codestringNMã của đối tác TNSL
results[].created_atDatetimeYNgày tạo CR
results[].created_byObjectYThông tin người tạo CR
results[].approved_byObjectYThông tin người duyệt CR
results[].itemsArrayYDanh sách Thông tin Sản phẩm đổi trả
results[].orderObjectYThông tin đơn hàng

Thông tin results[].order

ParamsTypeRequiredDescription
order_codestringYMã đơn hàng
order_idintegerNID của đơn hàng
order_typestringNLoại đơn hàng:
order_created_atDatetimeNNgày tạo đơn hàng
order_completed_atDatetimeYNgày hoàn thành đơn hàng
fulfillment_typestringYLoạ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_statusstringYTrạng thái tồn kho
payment_methodstringNPhương thức thanh toán
customerObjectYThông tin khách hàng
seller_infoObjectYThông tin người bán
statusstringNTrạng thái đơn hàng

Thông tin results[].items

ParamsTypeRequiredDescription
idintegerN
item_typestringYLoại item:order_fee: Phí của đơn hàngorder_product: Sản phẩm của đơn hàng
item_type_displayedstringYHiện thị loại item
fee_typestringNLoạ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_displayedstringNHiển thị loại phí
product_skustringNSKU của sản phẩm
qty_requestedintegerYSố lượng yêu cầu đổi trả
refund_amountintegerYSố tiền hoàn trả
resolution_typestringYLoại giải pháp khách hàng mong muốn:
PICKUP_ONLY: Chỉ thu hồi vật lý 
resolution_type_displayedstringYHiển thị loại giải pháp khách hàng mong muốn
order_lineObjectNThông tin sản phẩm đã mua
imagesarrayYThông tin hình ảnh đã upload
return_reasonObjectYLý do đổi trả
notestringNGhi chú
statusstringYTrạng thái sản phẩm đổi trả
status_displayedstringYHiển thị trạng thái sản phẩm đổi trả
created_atDatetimeNThời gian tạo
updated_atDatetimeNThời gian cập nhật
ams_versionstringYVersion của CR:
ams_v1: AMS Version 1
ams_v2: AMS Version 2

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

ParamsTypeRequiredDescription
codestringYMã code
namestringYTiêu đề
descriptionstringNMô tả
Was this article helpful to you? Yes No

How can we help?

Leave a Reply

Your email address will not be published.