Skip to main content
POST
/
products
Create Product
curl --request POST \
  --url https://api.loopreturns.com/api/v1/products \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "name": "<string>",
  "price": {
    "amount": 123,
    "currency_code": "USD"
  },
  "source": "<string>",
  "external_id": "<string>",
  "channel": "<string>",
  "sku": "<string>",
  "weight_grams": 123,
  "barcode": "<string>",
  "description": "<string>",
  "type": "<string>",
  "vendor": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "options": [
    {
      "position": 123,
      "values": [
        "<string>"
      ],
      "name": "<string>"
    }
  ],
  "images": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ]
}
'
{
  "product": {
    "id": 2,
    "external_id": "<string>",
    "channel": {},
    "sku": "<string>",
    "name": "<string>",
    "weight_grams": 123,
    "barcode": "<string>",
    "description": "<string>",
    "type": "<string>",
    "vendor": "<string>",
    "price": {
      "amount": 50000,
      "currency_code": "USD"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "collections": [
      {
        "id": 2,
        "external_id": "<string>",
        "name": "<string>"
      }
    ],
    "options": [
      {
        "position": 123,
        "values": [
          "<string>"
        ],
        "name": "<string>"
      }
    ],
    "images": [
      "<string>"
    ],
    "tags": [
      "<string>"
    ],
    "source": "<string>",
    "default_variant_id": "<string>"
  }
}

Authorizations

​
X-Authorization
string
header
required

API Scope: "Product (write)"

Body

application/json
​
name
string
required

The name of the product.

Maximum string length: 255
​
price
object
required

The price of the product in minor units, such as cents, with its corresponding currency.

Examples:
{ "amount": 50000, "currency_code": "USD" }
{ "amount": 25000 }
{ "amount": 1500, "currency_code": "EUR" }
​
source
string | null

The ecommerce platform from which the product is available.

Maximum string length: 255
Example:

"Shopify"

​
external_id
string | null

The provided external_id must be unique. If a non-unique external_id is provided, the API will respond with an error.

Maximum string length: 100
Example:

"564400c7-7a6b-4f29-b6a5-7bb580b2992c"

​
channel
string | null

If a channel with this name is not already associated with the shop, it will be used to create a new channel.

Maximum string length: 255
​
sku
string | null

The SKU of the product.

Maximum string length: 255
Example:

"SHOES-US44-M-Brwn"

​
weight_grams
integer | null

The weight of the product in grams.

​
barcode
string | null

The barcode of the product.

Maximum string length: 255
​
description
string | null

The description of the product.

Maximum string length: 65000
​
type
string | null

The "type" of the product. This is a single value used to classify and group similar products.

Maximum string length: 255
Example:

"shoes"

​
vendor
string | null

The manufacturer or seller of the product.

Maximum string length: 255
Example:

"Internal"

​
created_at
string<date-time> | null

The date and time at which the product was created.

Example:

"2023-04-25T18:25:00.000Z"

​
updated_at
string<date-time> | null

The date and time at which the product was updated. The value must be equal or greater than created_at.

Example:

"2023-04-25T13:45:00-05:00"

​
options
ProductOption · object[] | null

An array of optional features or characteristics of the product that can be selected by the customer.

​
images
string<uri>[] | null

An array of URLs which reference images of the product.

Minimum string length: 1
​
tags
string[] | null

An array of tags used to classify and group products.

Required string length: 1 - 255

Response

OK

​
product
ProductResponse · object