Skip to main content
POST
/
products
/
{productId}
/
product-variants
Create Product Variant
curl --request POST \
  --url https://api.loopreturns.com/api/v1/products/{productId}/product-variants \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "external_id": "<string>",
  "name": "<string>",
  "taxable": true,
  "sku": "<string>",
  "weight_grams": 123,
  "barcode": "<string>",
  "price": {
    "amount": 50000,
    "currency_code": "USD"
  },
  "images": [
    "<string>"
  ],
  "options": [
    {
      "position": 123,
      "value": "<string>"
    }
  ],
  "logistics_information": {
    "origin_country_code": "<string>",
    "origin_region_code": "<string>",
    "default_hs_code": "<string>",
    "requires_shipping": true,
    "cost": {
      "amount": 50000,
      "currency_code": "USD"
    },
    "destination_country_hs_codes": [
      {
        "destination_country_code": "<string>",
        "hs_code": "<string>"
      }
    ]
  }
}
'
{
  "product_variant": {
    "id": 2,
    "external_id": "<string>",
    "sku": "<string>",
    "name": "<string>",
    "weight_grams": 123,
    "barcode": "<string>",
    "product": {
      "id": 2,
      "external_id": "<string>",
      "sku": "<string>",
      "name": "<string>"
    },
    "price": {
      "amount": 50000,
      "currency_code": "USD"
    },
    "images": [
      "<string>"
    ],
    "inventories": {
      "id": 2,
      "available_count": 123,
      "location": {
        "id": 2,
        "external_id": "<string>",
        "name": "<string>"
      }
    },
    "options": [
      {
        "position": 123,
        "value": "<string>"
      }
    ],
    "logistics_information": {
      "origin_country_code": "<string>",
      "origin_region_code": "<string>",
      "default_hs_code": "<string>",
      "requires_shipping": true,
      "cost": {
        "amount": 50000,
        "currency_code": "USD"
      },
      "destination_country_hs_codes": [
        {
          "destination_country_code": "<string>",
          "hs_code": "<string>"
        }
      ]
    }
  }
}

Authorizations

​
X-Authorization
string
header
required

API Scope: "Product (write)"

Path Parameters

​
productId
integer
required

The unique Loop identifier of the parent product.

Body

application/json
​
external_id
string
required

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: 64
Example:

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

​
name
string
required

The name of the product variant.

Maximum string length: 255
Example:

"Classic Brown Dress Shoes - Size 12"

​
taxable
boolean
required

Whether or not the product variant is taxable.

​
sku
string | null

The SKU of the product variant.

Maximum string length: 255
Example:

"SHOES-US44-M-Brwn"

​
weight_grams
integer | null

The weight of the product variant in grams.

Example:

440

​
barcode
string | null

The barcode of the product variant.

Maximum string length: 255
Example:

712345000019

​
price
object

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

Example:
{ "amount": 50000, "currency_code": "USD" }
​
images
string<uri>[] | null
Minimum string length: 1
​
options
ProductVariantOption · object[] | null

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

​
logistics_information
ProductVariantLogisticsInformation · object

The logistics information for the product variant such as code classification, shipping, and cost.

Response

Success

​
product_variant
ProductVariantResponse · object