Order query api

5 min read

Advertisers need to provide the Domai channel orders to the Domai League inquiries, and the Domai Alliance will regularly read the interface synchronous order data.

Api Description

  • Support time granular query is second
  • Support order update time dimension query and sorting
  • Please contact Duori technicians for a whitelist IP
  • Can be added to verify, and the advertisers provide a key (requiring interface signature documents)

Default query frequency

Adjustable frequency on request

  • Query the data of the previous 5 minutes every 3 minutes
  • Query the data of the previous 1 hour every 1 hour
  • Inquiries 1 day before 1 day before 15 days of data

Api example

Advertisers can refer to the following examples to provide interfaces. If there is an interface and format, the interface document needs to be provided to Domai

https://www.yourdomain.com/cps/orders?union=duomai&stime=1373414581&etime=1373415181

ParameterParameter value ExampleParameter TypeParameter Description
unionduomaistringWhich CPS league order is distinguished, and the UNION parameter value of the interface interface
union_idduomaistringWhich CPS league order is distinguished, and the UNION parameter value of the interface interface
stime1373414581TimestampQuery the start time of order data(2013-07-10 08:03:10),It is recommended to use order update time
etime1373415181TimestampQuery the end time of order data(2013-07-10 08:13:10),It is recommended to use order update time
sn201303031111stringOrder number

Api return format example

MeaningCorresponding parameters (distinguished or lowercase)RequiredTypeExemplaryDetailed explanation
The label of the website transmitted by the access interfaceeuidyesstring100261230dGVzdA0EUID parameter value passed in the access interface
Advertiser ID of the website owner of the access interfacemidnostring10026The MID parameter value of the access interface
Order numberorder_snyesstring2013060412779
Sub order numbersuborder_snnostring050601
Order timeorder_timeyesdatetime2013-06-04 12:05:00The time when users place orders on your website
Click timeclick_timenodatetime2013-06-04 11:23:00The time when the user enters the access interface
Order amountorders_priceyesfloat200.00The amount paid by the user (the amount of the amount that does not calculate the commissions such as the use of the coupon/cash coupon/cash ticket fee), please do not use the 19,999 statement
Order statusorder_statusyesstringFor example: effective, invalid, unpaid, payment, delivery, etc.Description of order status of the merchant system
Order channelchannelnoint10 means the PC side, 1 indicates the WAP side, 3 means ROI orders, other values to be expanded, or the merchant can decide on its own
Whether it is a new customeris_new_customnostring1new customer:1 Non-new customers:0
Source linkreferernostringhttp://c.duomai.com/track.php?sid=10010&aid=123&euid=&t=http://www.yourdomain.com/Jump to the traffic source URL of the access interface
Currency codecurrencyMandatory when non-RMBstringCNYFor standard currency codes see:http://zh.wikipedia.org/zh/ISO_4217
Time zone codetimezoneMandatory when not in Beijing timestringUTC+8For standard time zone codes see: http://zh.wikipedia.org/zh/%E6%97%B6%E5%8C%BA%E5%88%97%E8%A1%A8
Whether to test datatestnoint1 or 0When passing test=1, a detailed push report will be fed back after the request, and the data will be sent to the test order database of the Duomai cps alliance, but the data will not be returned to the official order database
Product Numbergoods_idyesstring87154715Product SKUid
Product Namegoods_nameyesstringBalenciaga Women's Pre-Loved Black Calfskin Neoclassic Min
Product quantitygoods_tayesint2
Product Unit Pricegoods_priceyesint110
Product Total price (net amount)totalPriceyesint200The total price actually paid for the current product, coupons, shipping fees and other amounts need to be removed. This product has a discount of 20 yuan, then this value is 110*2-20=200
Product commission amountcommissionyesfloat24.00commission on merchandise
Product commission ratiorateyesfloat0.12The ratio of commodity commission to commodity amount
Product commission categorycommission_typenostringAClassification of commissions stipulated in the contract between the two parties
Product classification numbergoods_cateyesstring104
Product classification namegoods_cate_nameyesstringclothing
Product detaildetailsnoarrayWhen there are multiple commodities, you can put commodity data in this field, and a single data object contains information such as the above commodity fields goodsid, goodsname, ......, goods_cate_name, etc.