### Request Go Example Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-12-01 Example of how to make a request to the Retrieve Points API endpoint using Go. ```Go package main import ( "fmt" "io/ioutil" "net/http" "strings" ) func main() { url := "https://api.cafe24.com/points?shop_no=1&start_date=2023-01-01&end_date=2023-12-31&case=A&points_category=available&limit=20" client := &http.Client{} req, err := http.NewRequest("GET", url, nil) if err != nil { fmt.Printf("Error creating request: %s\n", err) return } req.Header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN") resp, err := client.Do(req) if err != nil { fmt.Printf("Error sending request: %s\n", err) return } defer resp.Body.Close() body, err := ioutil.ReadAll(resp.Body) if err != nil { fmt.Printf("Error reading response body: %s\n", err) return } fmt.Println(string(body)) } ``` -------------------------------- ### Request Go Example Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-09-01 Example of how to make a request to the Retrieve Points API using Go. ```Go package main import ( "fmt" "io/ioutil" "net/http" "strings" ) func main() { client := &http.Client{} req, err := http.NewRequest("GET", "https://api.cafe24.com/points?shop_no=1&start_date=2023-01-01&end_date=2023-12-31", nil) if err != nil { fmt.Println("Error creating request:", err) return } req.Header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN") resp, err := client.Do(req) if err != nil { fmt.Println("Error sending request:", err) return } defer resp.Body.Close() body, err := ioutil.ReadAll(resp.Body) if err != nil { fmt.Println("Error reading response body:", err) return } fmt.Println(string(body)) } ``` -------------------------------- ### API Request Examples Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-12-01 Provides examples for making requests to the Cafe24 API for coupon retrieval using various programming languages and cURL. ```cURL curl -X GET "https://developers.cafe24.com/docs/en/api/admin/?version=2024-12-01#none" -H "Authorization: Bearer YOUR_ACCESS_TOKEN" ``` ```Java // Java example for API request (placeholder) // Requires an HTTP client library like Apache HttpClient or OkHttp ``` ```Python # Python example for API request (placeholder) # Requires the 'requests' library ``` ```Node.js // Node.js example for API request (placeholder) // Requires 'axios' or built-in 'https' module ``` ```PHP // PHP example for API request (placeholder) // Requires cURL extension or a library like Guzzle ``` ```Go // Go example for API request (placeholder) // Uses the standard 'net/http' package ``` -------------------------------- ### Cafe24 API Request Examples Source: https://developers.cafe24.com/docs/en/api/front Examples of API requests for searching and registering/modifying data, including headers for content type, version, and client ID. ```APIDOC Request Example (search): 'https://{mallid}.cafe24api.com/{endpoint_url}' \ 'Content-Type: application/json' \ 'X-Cafe24-Api-Version: {version}' \ 'X-Cafe24-Client-Id: {client_id}' Request Example (register/modify): 'https://{mallid}.cafe24api.com/{endpoint_url}' \ 'Content-Type: application/json' \ 'X-Cafe24-Api-Version: {version}' \ 'X-Cafe24-Client-Id: {client_id}' \ '{ .... }' ``` -------------------------------- ### Cafe24 API: Versioning Example Source: https://developers.cafe24.com/docs/en/api/front Provides an example of how to specify a particular API version using the `X-Cafe24-Api-Version` header for requests, ensuring compatibility with older or specific API versions. ```HTTP 'https://{mallid}.cafe24api.com/api/v2/categories' 'Content-Type: application/json' 'X-Cafe24-Api-Version: 2025-06-01' 'X-Cafe24-Client-Id: BrIfqEKoP.......' ``` -------------------------------- ### Cafe24 API Request Examples Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-12-01 Provides cURL examples for searching and registering/modifying resources via the Cafe24 API. Includes placeholders for mall ID, access token, endpoint URL, and API version. ```APIDOC Request Example (search): 'https://{mallid}.cafe24api.com/{endpoint_url}' \ 'Authorization: Bearer {access_token}' \ 'Content-Type: application/json' \ 'X-Cafe24-Api-Version: {version}' ``` ```APIDOC Request Example (register/modify): 'https://{mallid}.cafe24api.com/{endpoint_url}' \ 'Authorization: Bearer {access_token}' \ 'Content-Type: application/json' \ 'X-Cafe24-Api-Version: {version}' \ '{ .... }' ``` -------------------------------- ### Request Python Example Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-09-01 Example of how to make a request to the Retrieve Points API using Python. ```Python import requests url = "https://api.cafe24.com/points" params = { "shop_no": 1, "start_date": "2023-01-01", "end_date": "2023-12-31" } headers = { "Authorization": "Bearer YOUR_ACCESS_TOKEN" } response = requests.get(url, params=params, headers=headers) if response.status_code == 200: print(response.json()) else: print(f"Error: {response.status_code}") ``` -------------------------------- ### Cafe24 API Request Examples Source: https://developers.cafe24.com/docs/en/api/admin Provides examples for making requests to the Cafe24 API, including search and register/modify operations. It shows the structure of headers and the base URL. ```APIDOC Request Example (search): 'https://{mallid}.cafe24api.com/{endpoint_url}' \ Authorization: Bearer {access_token} \ Content-Type: application/json \ X-Cafe24-Api-Version: {version}' Request Example (register/modify): 'https://{mallid}.cafe24api.com/{endpoint_url}' \ Authorization: Bearer {access_token} \ Content-Type: application/json \ X-Cafe24-Api-Version: {version}' \ '{ .... }' ``` -------------------------------- ### Create Multiple Order Returns - Code Examples Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-09-01 Provides code examples for creating multiple order returns using various programming languages. ```cURL curl -X POST https://{your-domain}/api/v2/admin/return ``` ```Java // Java code example for creating multiple order returns ``` ```Python # Python code example for creating multiple order returns ``` ```Node.js // Node.js code example for creating multiple order returns ``` ```PHP // PHP code example for creating multiple order returns ``` ```Go // Go code example for creating multiple order returns ``` -------------------------------- ### Request Python Example Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-12-01 Example of how to make a request to the Retrieve Points API endpoint using Python. ```Python import requests url = "https://api.cafe24.com/points" params = { "shop_no": 1, "start_date": "2023-01-01", "end_date": "2023-12-31", "case": "A", "points_category": "available", "limit": 20 } headers = { "Authorization": "Bearer YOUR_ACCESS_TOKEN" } response = requests.get(url, params=params, headers=headers) print(response.json()) ``` -------------------------------- ### Request Java Example Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-12-01 Example of how to make a request to the Retrieve Points API endpoint using Java. ```Java OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://api.cafe24.com/points?shop_no=1&start_date=2023-01-01&end_date=2023-12-31&case=A&points_category=available&limit=20") .addHeader("Authorization", "Bearer YOUR_ACCESS_TOKEN") .build(); try (Response response = client.newCall(request).execute()) { System.out.println(response.body().string()); } ``` -------------------------------- ### Request Java Example Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-09-01 Example of how to make a request to the Retrieve Points API using Java. ```Java import okhttp3.*; import java.io.IOException; public class Cafe24Points { public static void main(String[] args) throws IOException { OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://api.cafe24.com/points?shop_no=1&start_date=2023-01-01&end_date=2023-12-31") .addHeader("Authorization", "Bearer YOUR_ACCESS_TOKEN") .build(); try (Response response = client.newCall(request).execute()) { if (!response.isSuccessful()) throw new IOException("Unexpected code " + response); System.out.println(response.body().string()); } } } ``` -------------------------------- ### How to use GET API Source: https://developers.cafe24.com/docs/en/api/front_version=2024-12-01 Provides guidance on retrieving data using Cafe24 API's GET requests, explaining how to utilize various parameters for effective data recall. ```APIDOC How to use GET API: Cafe24 API provides several ways to get the data. The following describes the different ways to recall data using various parameters when inquiring an API. ``` -------------------------------- ### Request PHP Example Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-09-01 Example of how to make a request to the Retrieve Points API using PHP. ```PHP ``` -------------------------------- ### Request PHP Example Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-12-01 Example of how to make a request to the Retrieve Points API endpoint using PHP. ```PHP ``` -------------------------------- ### Request Node.js Example Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-09-01 Example of how to make a request to the Retrieve Points API using Node.js. ```Node.js const axios = require('axios'); const url = 'https://api.cafe24.com/points'; const params = { shop_no: 1, start_date: '2023-01-01', end_date: '2023-12-31' }; const headers = { 'Authorization': 'Bearer YOUR_ACCESS_TOKEN' }; axios.get(url, { params: params, headers: headers }) .then(response => { console.log(response.data); }) .catch(error => { console.error('Error fetching points:', error); }); ``` -------------------------------- ### Cafe24 Admin API Example Endpoint Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-09-01 An example URL structure for accessing the Cafe24 Admin API, demonstrating the base URL and a sample endpoint for a specific resource. ```APIDOC https://{mallid}.cafe24api.com/api/v2/admin/sampleapi ``` -------------------------------- ### Request Node.js Example Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-12-01 Example of how to make a request to the Retrieve Points API endpoint using Node.js. ```Node.js const axios = require('axios'); const url = 'https://api.cafe24.com/points'; const params = { shop_no: 1, start_date: '2023-01-01', end_date: '2023-12-31', case: 'A', points_category: 'available', limit: 20 }; const headers = { 'Authorization': 'Bearer YOUR_ACCESS_TOKEN' }; axios.get(url, { params: params, headers: headers }) .then(response => { console.log(response.data); }) .catch(error => { console.error(error); }); ``` -------------------------------- ### 1+N Event (Buy One Get One Free) Settings Source: https://developers.cafe24.com/docs/en/api/admin Detailed settings for 'buy one, get one free' incentives, including product lists and the number of additional products. ```APIDOC gift_product_bundle: product_list: Array of products product_bundle_type: Enum (P, I) (Required) product_bundle_count: Number (Required) ``` -------------------------------- ### Cafe24 API Request Examples Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-09-01 Examples of how to make requests to the Cafe24 API using cURL, including headers for authorization, content type, and API version. Covers both search and register/modify operations. ```APIDOC Request Example (search): 'https://{mallid}.cafe24api.com/{endpoint_url}' \ 'Authorization: Bearer {access_token}' \ 'Content-Type: application/json' \ 'X-Cafe24-Api-Version: {version}' ``` ```APIDOC Request Example (register/modify): 'https://{mallid}.cafe24api.com/{endpoint_url}' \ 'Authorization: Bearer {access_token}' \ 'Content-Type: application/json' \ 'X-Cafe24-Api-Version: {version}' \ '{ .... }' ``` -------------------------------- ### Create Bundle Product API Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-12-01 API endpoints for creating bundle products, with examples for different scenarios including minimal fields and excluding specific fields. ```APIDOC Create a bundle * [Create a bundle](https://developers.cafe24.com/docs/en/api/admin/?version=2024-12-01#none) * [Create a bundleproduct using only product_name, bundle_product_components, and bundle_product_sales fields](https://developers.cafe24.com/docs/en/api/admin/?version=2024-12-01#none) * [Try creating a bundleproduct without product_name field](https://developers.cafe24.com/docs/en/api/admin/?version=2024-12-01#none) * [Try creating a bundleproduct without bundle_product_components field](https://developers.cafe24.com/docs/en/api/admin/?version=2024-12-01#none) > Request cURL Java Python Node.js PHP Go [Copy](https://developers.cafe24.com/docs/en/api/admin/?version=2024-12-01#none) > Response [Copy](https://developers.cafe24.com/docs/en/api/admin/?version=2024-12-01#none) ``` -------------------------------- ### Cafe24 API: Create Multiple Order Returns (Go Example) Source: https://developers.cafe24.com/docs/en/api/admin Example of how to use the Cafe24 Admin API to create multiple order returns using Go. This snippet demonstrates constructing the JSON payload and making a POST request. ```Go package main import ( "bytes" "fmt" "io/ioutil" "net/http" "encoding/json" ) func main() { url := "https://{your-domain}.cafe24api.com/api/v2/admin/return" accessToken := "{access_token}" data := map[string]interface{}{ "shop_no": 1, "order_id": "ORDER123", "status": "returned", "reason": "Product was damaged during shipping.", "items": []interface{}{ map[string]interface{}{ "order_item_code": "ITEM001", "quantity": 1, }, }, "refund_method_code": "F", "request_pickup": "T", "pickup": map[string]string{ "name": "John Doe", "phone": "02-1234-5678", "cellphone": "010-1234-5678", "zipcode": "01234", "address1": "123 Main St", "address2": "Apt 4B", }, } jsonData, err := json.Marshal(data) if err != nil { fmt.Println("Error marshaling JSON:", err) return } req, err := http.NewRequest("POST", url, bytes.NewBuffer(jsonData)) if err != nil { fmt.Println("Error creating request:", err) return } req.Header.Set("Authorization", "Bearer "+accessToken) req.Header.Set("Content-Type", "application/json") client := &http.Client{} res, err := client.Do(req) if err != nil { fmt.Println("Error sending request:", err) return } defer res.Body.Close() body, err := ioutil.ReadAll(res.Body) if err != nil { fmt.Println("Error reading response body:", err) return } fmt.Println(string(body)) } ``` -------------------------------- ### Request Examples for Daily Visits Count API Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-12-01 Provides example requests for the Daily Visits Count API in various programming languages and cURL. ```cURL curl -X GET "https://api.cafe24.com/v1/visits/daily?shop_no=1&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD" -H "Authorization: Bearer YOUR_ACCESS_TOKEN" ``` ```Java // Java example would go here, using a library like OkHttp or HttpClient // Example structure: // OkHttpClient client = new OkHttpClient(); // Request request = new Request.Builder() // .url("https://api.cafe24.com/v1/visits/daily?shop_no=1&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD") // .addHeader("Authorization", "Bearer YOUR_ACCESS_TOKEN") // .build(); // Response response = client.newCall(request).execute(); ``` ```Python import requests url = "https://api.cafe24.com/v1/visits/daily" params = { "shop_no": 1, "start_date": "YYYY-MM-DD", "end_date": "YYYY-MM-DD" } headers = { "Authorization": "Bearer YOUR_ACCESS_TOKEN" } response = requests.get(url, params=params, headers=headers) print(response.json()) ``` ```Node.js const axios = require('axios'); const url = 'https://api.cafe24.com/v1/visits/daily'; const params = { shop_no: 1, start_date: 'YYYY-MM-DD', end_date: 'YYYY-MM-DD' }; const headers = { 'Authorization': 'Bearer YOUR_ACCESS_TOKEN' }; axios.get(url, { params: params, headers: headers }) .then(response => { console.log(response.data); }) .catch(error => { console.error(error); }); ``` ```PHP ``` ```Go package main import ( "fmt" "io/ioutil" "net/http" "strings" ) func main() { url := "https://api.cafe24.com/v1/visits/daily?shop_no=1&start_date=YYYY-MM-DD&end_date=YYYY-MM-DD" client := &http.Client{} req, err := http.NewRequest("GET", url, nil) if err != nil { fmt.Printf("Error creating request: %s\n", err) return } req.Header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN") resp, err := client.Do(req) if err != nil { fmt.Printf("Error sending request: %s\n", err) return } defer resp.Body.Close() body, err := ioutil.ReadAll(resp.Body) if err != nil { fmt.Printf("Error reading response body: %s\n", err) return } fmt.Println(string(body)) } ``` -------------------------------- ### API Versioning Request Example Source: https://developers.cafe24.com/docs/en/api/front_version=2025-03-01 Demonstrates how to set the API version using the 'X-Cafe24-Api-Version' header in various programming languages. ```javascript 'https://{mallid}.cafe24api.com/api/v2/categories' \ 'Content-Type: application/json' \ 'X-Cafe24-Api-Version: 2025-03-01' \ 'X-Cafe24-Client-Id: BrIfqEKoP.......' ``` ```curl curl -H "Content-Type: application/json" -H "X-Cafe24-Api-Version: 2025-03-01" -H "X-Cafe24-Client-Id: BrIfqEKoP......." 'https://{mallid}.cafe24api.com/api/v2/categories' ``` ```java // Java example would involve setting headers in an HTTP client request. ``` ```python # Python example would involve setting headers in a requests library call. ``` ```php // PHP example would involve setting headers in a cURL or Guzzle request. ``` ```go // Go example would involve setting headers in an http.Request. ``` -------------------------------- ### Retrieve App Installation Information Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-09-01 Retrieves the app installation information for a specific customer. Requires shop number and member ID. The API endpoint is GET /api/v2/admin/customers/{member_id}/plusapp. ```APIDOC GET /api/v2/admin/customers/{member_id}/plusapp Parameters: shop_no (int, optional): Shop Number. Min: 1. Default: 1. member_id (str, required): Member ID. Properties: shop_no (int): Shop Number. os_type (str): OS Type. install_date (str): Installation date. auto_login_flag (bool): Whether the user opted-in to use the auto-login feature. use_push_flag (bool): Whether the user opted-in to receive push notifications. Scope: mall.read_customer Request Limit: 40 ``` -------------------------------- ### Get Access Token Source: https://developers.cafe24.com/docs/en/api/admin_version=2025-03-01 Explains how to exchange an authentication code for an access token and a refresh token. It lists the required parameters for the token request and provides an example of the successful response, including token details and scopes. ```APIDOC Request Example (cURL): `'https://{mallid}.cafe24api.com/api/v2/oauth/token' \ 'Authorization: Basic {base64_encode({client_id}:{client_secret})}' \ 'Content-Type: application/x-www-form-urlencoded' \ 'grant_type=authorization_code&code={code}&redirect_uri={redirect_uri}'` Response Example: `HTTP/1.1 200 OK { "access_token": "0iqR5nM5EJIq........", "expires_at": "2021-03-01T14:00:00.000", "refresh_token": "JeTJ7XpnFC0P........", "refresh_token_expires_at": "2021-03-15T12:00:00.000", "client_id": "BrIfqEKoPxeE........", "mall_id": "yourmall", "user_id": "test", "scopes": [ "mall.read_order", "mall.read_product", "mall.read_store", "...etc...", ], "issued_at": "2021-03-01T12:00:00.000" }` ``` -------------------------------- ### Cafe24 API GET: Pagination Source: https://developers.cafe24.com/docs/en/api/admin_version=2025-03-01 Explains how to implement pagination for results using 'limit' and 'offset' parameters. 'limit' controls the number of items per response, and 'offset' specifies the starting point for retrieving subsequent sets of data. ```APIDOC GET https://{mallid}.cafe24api.com/api/v2/admin/products?limit=100 GET https://{mallid}.cafe24api.com/api/v2/admin/products?limit=100&offset=200 ``` -------------------------------- ### Get Authentication Code Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-09-01 Details the process of requesting an authorization code to obtain an access token. It outlines the necessary parameters for the request, including mall ID, client ID, state, redirect URI, and scope, and provides an example of the request and response. ```APIDOC GET 'https://{mallid}.cafe24api.com/api/v2/oauth/authorize?response_type=code&client_id={client_id}&state={state}&redirect_uri={redirect_uri}&scope={scope}' HTTP/1.1 302 Found Location: {redirect_uri}?code={authorize_code}&state={state} ``` -------------------------------- ### Cafe24 Front API Introduction Source: https://developers.cafe24.com/docs/en/api/front_version=2024-12-01 Introduces the Cafe24 Front API, highlighting its suitability for public information and customer-specific data access, with limitations compared to Admin API. Provides an example URL structure. ```APIDOC Front API Intro: - Front API is suitable for public information (displayed product information) or for customers to get their own information or write at a board. - Front API is limited for some information compared to Admin API. Example: https://{mallid}.cafe24api.com/api/v2/sampleapi ``` -------------------------------- ### Cafe24 Front API - Introduction and General Information Source: https://developers.cafe24.com/docs/en/api/front_version=2025-03-01 This section provides an overview of the Cafe24 Front API, including its structure, request/response formats, methods, status codes, and versioning strategy. It also explains how to use GET requests and API rate limits. ```APIDOC APIDOC: API Index: Provides a comprehensive list of all available API endpoints. Introduction: General overview of the Cafe24 API. Cafe24 API: Details about the Cafe24 API ecosystem. API Diagram: Visual representation of API interactions. Request/Response Format: Specifies the structure of requests and responses (e.g., JSON). Method: Explains the HTTP methods used (GET, POST, PUT, DELETE). Front API Intro: Specific introduction to the Front API. API Status Code: Lists common HTTP status codes and their meanings. How to use GET API: Guide on making GET requests to retrieve data. API Limit: Information on rate limiting and usage quotas. Versioning: Details on how the API versions are managed. ``` -------------------------------- ### Request cURL Example Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-12-01 Example of how to make a request to the Retrieve Points API endpoint using cURL. ```cURL curl -X GET "https://api.cafe24.com/points?shop_no=1&start_date=2023-01-01&end_date=2023-12-31&case=A&points_category=available&limit=20" \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" ``` -------------------------------- ### Cafe24 API Introduction and Usage Source: https://developers.cafe24.com/docs/en/api/front_version=2024-09-01 Provides an overview of the Cafe24 API, including its structure, request/response formats, versioning, and how to use GET requests. It also details API status codes and limits. ```APIDOC API Index: - Introduction - Cafe24 API - API Diagram - Request/Response Format - Method - Front API Intro - API Status Code - How to use GET API - API Limit - Versioning ``` -------------------------------- ### Cafe24 Front API Introduction Source: https://developers.cafe24.com/docs/en/api/front_version=2025-03-01 Introduces the Cafe24 Front API, highlighting its suitability for public information and customer-specific data access, with limitations compared to the Admin API, and provides an example API endpoint. ```APIDOC Front API Intro: - Front API is suitable for public information (displayed product information) or for customer to get their own information or write at a board. - Front API is limited for some informations compare to Admin API. Example: https://{mallid}.cafe24api.com/api/v2/sampleapi ``` -------------------------------- ### Product Display and Description Settings Source: https://developers.cafe24.com/docs/en/api/front Configures how product information is displayed, including main page visibility, descriptions (including mobile and simple versions), and tags. ```APIDOC main: Description: Displays main display number when displaying products on the main page (e.g., 'recommend product' or 'new'). channeldiscountprices: Description: Product discount sale price resource. memos: Description: Memos resource. Can search using the embed parameter. seo: Description: Product SEO resource. Can search using the embed parameter. description: Description: Detail description of the product. May include HTML. mobile_description: Description: Mobile version of the product description. Replaces the product description when a customer accesses a mobile shopping mall. separated_mobile_description: Description: Adds a mobile version of product details. Types: T: add mobile version product details F: apply PC version product details simple_description: Description: Simple description of the product. Can be exposed on the product display screen. May include HTML. tags: Description: Product Tag Resource. Can search using the embed parameter. ``` -------------------------------- ### Cafe24 Admin API Introduction and Usage Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-12-01 Provides an overview of the Cafe24 Admin API, including its structure, request/response formats, methods, status codes, and versioning. It also details how to use GET requests and explains API rate limits. ```APIDOC API Index: https://developers.cafe24.com/docs/en/api/admin/?version=2024-12-01#api-index Introduction: https://developers.cafe24.com/docs/en/api/admin/?version=2024-12-01#introduction Cafe24 API: https://developers.cafe24.com/docs/en/api/admin/?version=2024-12-01#cafe24-api API Diagram: https://developers.cafe24.com/docs/en/api/admin/?version=2024-12-01#api-diagram Request/Response Format: https://developers.cafe24.com/docs/en/api/admin/?version=2024-12-01#request-response-format Method: https://developers.cafe24.com/docs/en/api/admin/?version=2024-12-01#method Admin API Intro: https://developers.cafe24.com/docs/en/api/admin/?version=2024-12-01#admin-api-intro API Status Code: https://developers.cafe24.com/docs/en/api/admin/?version=2024-12-01#api-status-code How to use GET API: https://developers.cafe24.com/docs/en/api/admin/?version=2024-12-01#how-to-use-get-api API Limit: https://developers.cafe24.com/docs/en/api/admin/?version=2024-12-01#api-limit Versioning: https://developers.cafe24.com/docs/en/api/admin/?version=2024-12-01#versioning ``` -------------------------------- ### Request cURL Example Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-09-01 Example of how to make a request to the Retrieve Points API using cURL. ```cURL curl -X GET \ 'https://api.cafe24.com/points?shop_no=1&start_date=2023-01-01&end_date=2023-12-31' \ -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' ``` -------------------------------- ### Cafe24 API: Create a Bundle Product Source: https://developers.cafe24.com/docs/en/api/admin Creates a set product, allowing for additional set product discounts to be applied to the bundled product's price. ```APIDOC POST /api/v2/admin/bundleproducts Description: Lets you create a set product. Additional set product discounts can be applied to the price of the bundled product. Scope: mall.write_product Request Limit: 40 ``` -------------------------------- ### Cafe24 Front API Introduction Source: https://developers.cafe24.com/docs/en/api/front Provides an overview of the Cafe24 Front API, highlighting its suitability for public information and customer-specific data, and its limitations compared to the Admin API. ```APIDOC Front API Intro: Suitable for public information (displayed product information) or for customer to get their own information or write at a board. Limited for some informations compare to Admin API. Example: https://{mallid}.cafe24api.com/api/v2/sampleapi ``` -------------------------------- ### API Documentation: Retrieve a list of bundles Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-09-01 Allows looking up set products by checking product code, your own product code, product name, etc. Requires mall.read_product scope and has a request limit of 40. ```APIDOC GET /api/v2/admin/bundleproducts **Description:** You can look up the set product through the list. You can check the product code, your own product code, product name, etc. **Specification:** * **SCOPE:** mall.read_product * **Request Limit:** 40 ``` -------------------------------- ### Cafe24 Front API Introduction Source: https://developers.cafe24.com/docs/en/api/front_version=2024-09-01 Provides an overview of the Cafe24 Front API, highlighting its suitability for public information and customer-specific data access, with limitations compared to Admin API. ```APIDOC Front API Intro: - Suitable for public information (displayed product information) or for customers to get their own information or write at a board. - Limited for some information compared to Admin API. Example: https://{mallid}.cafe24api.com/api/v2/sampleapi ``` -------------------------------- ### How to use GET API with Cafe24 Source: https://developers.cafe24.com/docs/en/api/front_version=2024-09-01 Explains various methods to retrieve data using Cafe24 API's GET requests, focusing on the use of different parameters for data recall. ```APIDOC How to use GET API: Cafe24 API provides several ways to get the data. The following describes the different ways to recall data using various parameters when inquiring an API. ``` -------------------------------- ### Retrieve Customer Plus App Installation Information Source: https://developers.cafe24.com/docs/en/api/admin_version=2025-03-01 Retrieves the Plus App installation information for a specific shopping mall member. Requires shop number and member ID. ```APIDOC GET /api/v2/admin/customers/{member_id}/plusapp #### Specification **Property** | **Description** ---|--- SCOPE | **mall.read_customer** Request Limit | **40** #### Request **Parameter** | **Description** ---|--- shop_no _Min : [1]_ | Shop Number DEFAULT 1 **member_ id** **Required** | Member id Retrieve app installation information ``` -------------------------------- ### Create Product Resource Source: https://developers.cafe24.com/docs/en/api/admin_version=2025-03-01 Allows for the registration of new products within the Cafe24 shopping mall. Product options can also be registered concurrently. Requires 'mall.write_product' scope. ```APIDOC POST /api/v2/admin/products Scope: mall.write_product Request Limit: 40 Objects per single API call Limit: 1 ``` -------------------------------- ### Retrieve Plus App Installation Information Source: https://developers.cafe24.com/docs/en/api/admin Fetches the installation status of the Plus App for a specific shopping mall member. Requires mall.read_customer scope and has a request limit of 40. ```APIDOC GET /api/v2/admin/customers/{member_id}/plusapp Parameters: - shop_no (int, optional, min: 1): Shop Number. Defaults to 1. - member_id (string, required): The ID of the member. Scope: mall.read_customer Request Limit: 40 ``` -------------------------------- ### Using GET API with Search Conditions Source: https://developers.cafe24.com/docs/en/api/front Demonstrates how to retrieve data using GET requests by adding various search conditions and parameters to API endpoints, including date range filtering. ```APIDOC How to use GET API: Add search conditions by adding parameters to an endpoint. Use ampersands (&) to separate multiple search conditions. Examples: Searching for products of which price is KRW 1,000 or higher in a certain brand: GET https://{mallid}.cafe24api.com/api/v2/products?brand_code=B000000A&price_min=1000 Searching for products by specifying the date range in which they were added: GET https://{mallid}.cafe24api.com/api/v2/products?created_start_date=2018-01-03&created_end_date=2018-02-03 Searching for products by specifying the date range in which they were edited: GET https://{mallid}.cafe24api.com/api/v2/products?updated_start_date=2018-01-03T14:01:26+09:00&updated_end_date=2018-02-03T14:01:26+09:00 ``` -------------------------------- ### Retrieve Main Screen Product Settings API Source: https://developers.cafe24.com/docs/en/api/admin_version=2025-03-01 Retrieves additional settings for products displayed on the main screen. This API fetches configuration details for featured products. ```APIDOC GET /api/v2/settings/mains/products Description: Retrieves additional settings for products on the main screen. Parameters: None Returns: Additional settings for main screen products. ``` -------------------------------- ### How to use GET API - Add Search Conditions Source: https://developers.cafe24.com/docs/en/api/admin_version=2024-12-01 Demonstrates how to use GET requests to retrieve data by adding search conditions as parameters to the API endpoint. Multiple conditions can be combined using ampersands (&). ```HTTP GET https://{mallid}.cafe24api.com/api/v2/products?brand_code=B000000A&price_min=1000 GET https://{mallid}.cafe24api.com/api/v2/products?created_start_date=2018-01-03&created_end_date=2018-02-03 GET https://{mallid}.cafe24api.com/api/v2/products?updated_start_date=2018-01-03T14:01:26+09:00&updated_end_date=2018-02-03T14:01:26+09:00 ```