Mappings

SKU Mappings API

Manage product SKU mappings to use your own product codes with the Regen Therapy platform.

GET/v1/mappings/skus
List all SKU mappings for your account

Query Parameters

ParameterTypeDescription
pageintegerPage number (default: 1)
limitintegerItems per page (default: 50, max: 100)
searchstringSearch by external SKU, platform SKU, or name
privateLabelbooleanFilter by private label status
curl -X GET "https://gateway.regentherapy.com/api/v1/mappings/skus?limit=50" \
  -H "X-API-Key: your_api_key"
POST/v1/mappings/skus
Create a new SKU mapping

Request Body

FieldTypeRequiredDescription
externalSkustringYesYour custom SKU code
platformSkustringYesPlatform product SKU to map to
externalNamestringNoCustom product name (for private labels)
externalBarcodestringNoYour UPC/barcode
priceOverridenumberNoCustom price for this mapping
isPrivateLabelbooleanNoFlag as private label product
priorityintegerNoResolution priority (higher = preferred)
curl -X POST "https://gateway.regentherapy.com/api/v1/mappings/skus" \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "externalSku": "MY-CBD-1000",
    "platformSku": "CBD-OIL-1000-FS",
    "externalName": "Wellness CBD Oil 1000mg",
    "priceOverride": 59.99,
    "isPrivateLabel": true
  }'
POST/v1/mappings/skus/bulk
Import multiple SKU mappings at once (up to 500)

Request Body

FieldTypeDescription
mappingsarrayArray of mapping objects (max 500)
updateExistingbooleanUpdate existing mappings if found (default: false)
curl -X POST "https://gateway.regentherapy.com/api/v1/mappings/skus/bulk" \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "updateExisting": true,
    "mappings": [
      { "externalSku": "WEL-500", "platformSku": "CBD-OIL-500-FS" },
      { "externalSku": "WEL-1000", "platformSku": "CBD-OIL-1000-FS", "priceOverride": 59.99 },
      { "externalSku": "WEL-GUMMY", "platformSku": "CBD-GUMMY-30CT", "isPrivateLabel": true }
    ]
  }'
// Response
{
  "success": true,
  "data": {
    "summary": {
      "total": 3,
      "created": 2,
      "updated": 1,
      "skipped": 0,
      "failed": 0
    },
    "results": [
      { "externalSku": "WEL-500", "success": true, "action": "created" },
      { "externalSku": "WEL-1000", "success": true, "action": "updated" },
      { "externalSku": "WEL-GUMMY", "success": true, "action": "created" }
    ]
  }
}
POST/v1/mappings/skus/resolve
Test SKU resolution without creating an order

Use this endpoint to verify your SKU mappings work correctly before submitting orders.

curl -X POST "https://gateway.regentherapy.com/api/v1/mappings/skus/resolve" \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "skus": ["WEL-500", "WEL-1000", "INVALID-SKU"]
  }'
{
  "success": true,
  "data": {
    "summary": {
      "total": 3,
      "resolved": 2,
      "unresolved": 1,
      "allResolved": false
    },
    "results": [
      {
        "externalSku": "WEL-500",
        "resolved": true,
        "platformSku": "CBD-OIL-500-FS",
        "platformProductId": "prod_abc123",
        "productName": "Wellness CBD 500mg",
        "productPrice": 39.99,
        "productActive": true,
        "isPrivateLabel": false
      },
      {
        "externalSku": "WEL-1000",
        "resolved": true,
        "platformSku": "CBD-OIL-1000-FS",
        "platformProductId": "prod_def456",
        "productName": "Wellness CBD 1000mg",
        "productPrice": 69.99,
        "priceOverride": 59.99,
        "productActive": true,
        "isPrivateLabel": true
      },
      {
        "externalSku": "INVALID-SKU",
        "resolved": false,
        "error": "SKU 'INVALID-SKU' not found in mappings or product catalog"
      }
    ]
  }
}
PUT/v1/mappings/skus/:id
Update an existing SKU mapping
curl -X PUT "https://gateway.regentherapy.com/api/v1/mappings/skus/map_abc123" \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "externalName": "Updated Product Name",
    "priceOverride": 54.99
  }'
DELETE/v1/mappings/skus/:id
Delete a SKU mapping (soft delete)
curl -X DELETE "https://gateway.regentherapy.com/api/v1/mappings/skus/map_abc123" \
  -H "X-API-Key: your_api_key"
SKU Mapping Object
Complete structure of a SKU mapping
FieldTypeDescription
idstringUnique mapping identifier
externalSkustringYour custom SKU code
platformProductIdstringPlatform product ID
platformSkustringPlatform product SKU
externalNamestring | nullCustom product name
externalBarcodestring | nullCustom UPC/barcode
priceOverridenumber | nullCustom price override
isPrivateLabelbooleanPrivate label flag
priorityintegerResolution priority
productobjectLinked platform product details
createdAtstringISO 8601 creation timestamp
updatedAtstringISO 8601 last update timestamp

Related Resources