GET /v1/commerce/referrals/performance

GET/v1/commerce/referrals/performance

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Responses

200OK

codesReferralCodePerformance[] | nullrequired

Show properties

Array of ReferralCodePerformance

codestringrequired

gmvinteger<int64>required

order_countinteger<int64>required

ordersReferralAttributedOrder[] | nullrequired

Show properties

Array of ReferralAttributedOrder

customer_phonestring

order_nostringrequired

referral_codestringrequired

statusstringrequired

total_amountinteger<int64>required

defaultError

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/commerce/referrals/performance"

const response = await fetch("/v1/commerce/referrals/performance", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/commerce/referrals/performance",
)

Response

{
  "codes": [
    {
      "code": "string",
      "gmv": 0,
      "order_count": 0
    }
  ],
  "orders": [
    {
      "customer_phone": "string",
      "order_no": "string",
      "referral_code": "string",
      "status": "string",
      "total_amount": 0
    }
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}