Update sample request

Update Sample Request

curl --request PATCH \
  --url https://api.growi.io/api/public/v1/sample_requests/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "order_id": "<string>",
  "order_name": "<string>",
  "tracking_url": "<string>"
}
'

import requests

url = "https://api.growi.io/api/public/v1/sample_requests/{id}"

payload = {
    "order_id": "<string>",
    "order_name": "<string>",
    "tracking_url": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({order_id: '<string>', order_name: '<string>', tracking_url: '<string>'})
};

fetch('https://api.growi.io/api/public/v1/sample_requests/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growi.io/api/public/v1/sample_requests/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'order_id' => '<string>',
    'order_name' => '<string>',
    'tracking_url' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growi.io/api/public/v1/sample_requests/{id}"

	payload := strings.NewReader("{\n  \"order_id\": \"<string>\",\n  \"order_name\": \"<string>\",\n  \"tracking_url\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.growi.io/api/public/v1/sample_requests/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"order_id\": \"<string>\",\n  \"order_name\": \"<string>\",\n  \"tracking_url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.growi.io/api/public/v1/sample_requests/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"order_id\": \"<string>\",\n  \"order_name\": \"<string>\",\n  \"tracking_url\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": 123,
    "status": "pending",
    "campaign_id": 123,
    "campaign_name": "<string>",
    "campaign_affiliate_id": 123,
    "source": "<string>",
    "creator": {
      "user_id": 123,
      "name": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "phone": "<string>"
    },
    "product": {
      "id": 123,
      "title": "<string>",
      "sku": "<string>",
      "url": "<string>",
      "image_url": "<string>",
      "shopify_id": "<string>",
      "tik_tok_id": "<string>",
      "amazon_product_id": "<string>"
    },
    "variant": {
      "id": 123,
      "title": "<string>",
      "display_name": "<string>",
      "sku": "<string>",
      "external_id": "<string>",
      "price": 123
    },
    "quantity": 123,
    "shipping_address": {
      "first_name": "<string>",
      "last_name": "<string>",
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>",
      "phone": "<string>"
    },
    "order_id": "<string>",
    "order_name": "<string>",
    "tracking_url": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

PATCH

sample_requests

{id}

Update Sample Request

curl --request PATCH \
  --url https://api.growi.io/api/public/v1/sample_requests/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "order_id": "<string>",
  "order_name": "<string>",
  "tracking_url": "<string>"
}
'

import requests

url = "https://api.growi.io/api/public/v1/sample_requests/{id}"

payload = {
    "order_id": "<string>",
    "order_name": "<string>",
    "tracking_url": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({order_id: '<string>', order_name: '<string>', tracking_url: '<string>'})
};

fetch('https://api.growi.io/api/public/v1/sample_requests/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growi.io/api/public/v1/sample_requests/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'order_id' => '<string>',
    'order_name' => '<string>',
    'tracking_url' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growi.io/api/public/v1/sample_requests/{id}"

	payload := strings.NewReader("{\n  \"order_id\": \"<string>\",\n  \"order_name\": \"<string>\",\n  \"tracking_url\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.growi.io/api/public/v1/sample_requests/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"order_id\": \"<string>\",\n  \"order_name\": \"<string>\",\n  \"tracking_url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.growi.io/api/public/v1/sample_requests/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"order_id\": \"<string>\",\n  \"order_name\": \"<string>\",\n  \"tracking_url\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": 123,
    "status": "pending",
    "campaign_id": 123,
    "campaign_name": "<string>",
    "campaign_affiliate_id": 123,
    "source": "<string>",
    "creator": {
      "user_id": 123,
      "name": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "phone": "<string>"
    },
    "product": {
      "id": 123,
      "title": "<string>",
      "sku": "<string>",
      "url": "<string>",
      "image_url": "<string>",
      "shopify_id": "<string>",
      "tik_tok_id": "<string>",
      "amazon_product_id": "<string>"
    },
    "variant": {
      "id": 123,
      "title": "<string>",
      "display_name": "<string>",
      "sku": "<string>",
      "external_id": "<string>",
      "price": 123
    },
    "quantity": 123,
    "shipping_address": {
      "first_name": "<string>",
      "last_name": "<string>",
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>",
      "phone": "<string>"
    },
    "order_id": "<string>",
    "order_name": "<string>",
    "tracking_url": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

Reports what happened to a sample request after you fulfill it: mark it shipped or delivered and save your order details. Each status change sends the matching webhook event.

Requires a full-access API key (read-only keys are rejected).

Path parameters

Parameter	Type	Description	Required
`id`	Integer	Sample request id	Yes

Body parameters

Parameter	Type	Description	Required
`status`	String	`approved`, `rejected`, `shipped` or `delivered`	No
`order_id`	String	Your order id	No
`order_name`	String	Your order number	No
`tracking_url`	String	Tracking link for the package	No

Allowed status changes:

From	To
`pending`	`approved`, `rejected`
`approved`	`shipped`, `delivered`
`shipped`	`shipped`, `delivered`

Send only order_id, order_name or tracking_url to update them without changing the status.

Request example

curl -X PATCH "https://api.growi.io/api/public/v1/sample_requests/812345" \
  -H "Authorization: Bearer YOUR_PUBLIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "shipped",
    "order_id": "FB-100231",
    "order_name": "#100231",
    "tracking_url": "https://www.ups.com/track?tracknum=1Z999AA10123456784"
  }'

Response

Returns the updated sample request in data. See List sample requests for the fields.

Error responses

403: read-only API key

{ "error": "This API key is read-only and cannot modify data." }

404: not found for your organization

{ "error": "Sample request not found" }

422: invalid status or transition

{ "error": "Cannot mark a pending sample request as shipped" }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

integer

required

Sample request id

Body

application/json

status

enum<string>

approved and rejected need a pending request; shipped needs an approved one; delivered needs an approved or shipped one

Available options:

approved,

rejected,

shipped,

delivered

order_id

string

Your order id

order_name

string

Your order number

tracking_url

string

Tracking link for the creator

Response

Sample request updated

data

object

Show child attributes

Overview

Conversions

Tracking events

Campaign affiliates

Organization

Applications

Sample requests

Stats

TikTok Shop

Meta ads

Update sample request

Path parameters

Body parameters

Request example

Response

Error responses

Authorizations

Path Parameters

Body

Response

​Path parameters

​Body parameters

​Request example

​Response

​Error responses

Authorizations

Path Parameters

Body

Response

Path parameters

Body parameters

Request example

Response

Error responses