Public
Documentation Settings
No Environment
Double Column
cURL - cURL
CreditsYard
Introduction
Customer
Credits
Orders

CreditsYard

AUTHORIZATIONAPI Key
Key

X-Shop-Api-Key

Customer

Shopify liquid Variables:

  • customer.metafields.creditsyard.store_credit_balance
  • customer.metafields.creditsyard.store_credit_last_updated
AUTHORIZATIONAPI Key
This folder is using API Key from collectionCreditsYard

GETGet customers

https://creditsyard.com/api/common/customers/index
Header
X-Shop-Api-Key
"X-Shop-Api-Key": "SgdIFpTDkUDa1Wm4N93RM"
Merchant's Shop API key (required)
Body
start_date (optional)
"start_date": "2024-01-01"
(Optional) Retrieve customers who have credits created starting from "start_date"
end_date (optional)
"end_date": "2024-01-31"
(Optional) Retrieve customers who have credits created between "start_date" and "end_date"
page (integer)
Used to specify the page number for paginated results.
AUTHORIZATIONAPI Key
This request is using API Key from collectionCreditsYard
Example Request
Example
curl
curl --location 'https://creditsyard.com/api/common/customers/index' \
--header 'Content-Type: application/json' \
--header 'X-Shop-Api-Key: SgdIFpTDkUDa1Wm4N93RMIzmD' \
--data-raw '{
    "customer_email": "customer@example.com"
}'
200 OK
Example Response
json
{
    "data": [
        {
            "id": "7204059185435",
            "email": "customer@domain.com",
            "name": "Customer name",
            "balance": 100,
            "activity": [
                {
                    "amount": 100,
                    "reason": null,
                    "order_name": null,
                    "date": "09/11/2024"
                },
            ]
        }
    ],
    "pagination": {
        "current_page": 1,
        "last_page": 13,
        "per_page": 10,
        "total": 130,
        "next_page_url": "https://creditsyard.com/api/common/customers/index?page=2",
        "prev_page_url": null
    }
}
No response headers
This request doesn't return any response headers

GETFind customer

https://creditsyard.com/api/common/customers/get
Header
X-Shop-Api-Key"X-Shop-Api-Key": "SgdIFpTDkUDa1Wm4N93RM"
Merchant's Shop API key (required)
Body
customer_id"customer_id": "5307768438942"
Customer's id on merchant's store (required if customer_email is not set)
customer_email"customer_email": "customer@example.com"
Customer's email (required if customer_id is not set)
AUTHORIZATIONAPI Key
This request is using API Key from collectionCreditsYard
Example Request
Example
curl
curl --location 'https://creditsyard.com/api/common/customers/get' \
--header 'Content-Type: application/json' \
--header 'X-Shop-Api-Key: SgdIFpTDkUDa1Wm4N93RMIzmD' \
--data-raw '{
    "customer_email": "customer@example.com"
}'
200 OK
Example Response
json
{
  "id": "5307768438942",
  "email": "customer@example.com",
  "balance": 300,
  "tags": [
    "VIP"
  ],
  "activity": [
    {
      "amount": 100,
      "reason": "Bag exchange",
      "order_id": null,
      "date": "09/01/2021"
    },
    {
      "amount": 200,
      "reason": "Refund for order replacement",
      "order_id": null,
      "date": "07/18/2021"
    }
  ]
}
No response headers
This request doesn't return any response headers

POSTUpdate customer

https://creditsyard.com/api/common/customers/update
Header
X-Shop-Api-Key
"X-Shop-Api-Key": "SgdIFpTDkUDa1Wm4N93RM"
Merchant's Shop API key (required)
Body
customer_id
"customer_id": "5307768438942"
Customer's id on merchant's store (required if customer_email is not set)
customer_email
"customer_email": "customer@example.com"
Customer's email (required if customer_id is not set)
name
"name": "James"
Customer's name
custom_shipping_value
"custom_shipping_value": "10"
Custom shipping cost
tags
["tag1", "tag2"]
Customer's tags
AUTHORIZATIONAPI Key
This request is using API Key from collectionCreditsYard
Example Request
Example
curl
curl --location 'https://creditsyard.com/api/common/customers/update' \
--header 'Content-Type: application/json' \
--header 'X-Shop-Api-Key: SgdIFpTDkUDa1Wm4N93RMIzmD' \
--data-raw '{
    "customer_email": "customer@example.com",
    "name": "James",
    "tags": ["tag1", "tag2"]
}'
200 OK
Example Response
json
{
  "id": "5307768438942",
  "email": "customer@example.com",
  "name": "James",
  "tags": [
    "tag1",
    "tag2"
  ]
}
No response headers
This request doesn't return any response headers