Upsert products (batch)

Create or update up to 1000 products in one request. Each product is matched on its source, source account ID, and source ID, so you can safely send the same request again. Each product succeeds or fails on its own: check status on every result, and errors on the ones that failed.

POST /products/batch

Upsert Products

cURL

curl --request POST \
  --url https://api.taxwire.com/products/batch \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "data": [
    {
      "source_id": "SKU-123",
      "source": "shopify",
      "source_account_id": "acme-us.myshopify.com",
      "name": "Organic Coffee Beans",
      "tax_codes": [
        "TANGIBLE_PERSONAL_PROPERTY.FOOD"
      ],
      "source_updated_at": "2026-09-15T08:30:00Z"
    },
    {
      "source_id": "SKU-124",
      "source": "shopify",
      "source_account_id": "acme-ca.myshopify.com",
      "name": "Ceramic Mug",
      "description": "12 oz stoneware mug",
      "source_updated_at": "2026-09-15T08:29:41Z"
    },
    {
      "source_id": "SKU-125",
      "source": "shopify",
      "name": "Travel Tumbler"
    },
    {
      "source_id": "SKU-126",
      "source": "shopify",
      "source_account_id": "acme-us.myshopify.com"
    }
  ]
}
'

200

{
  "object": "batch",
  "summary": {
    "created": 1,
    "updated": 1,
    "stale": 0,
    "deleted": 0,
    "failed": 2
  },
  "data": [
    {
      "index": 0,
      "status": "updated",
      "product": {
        "id": "prd_01J9Z8Q4E7K2M3N4P5R6S7T8U9",
        "source_id": "SKU-123",
        "source": "shopify",
        "source_account_id": "acme-us.myshopify.com",
        "name": "Organic Coffee Beans",
        "description": "12 oz bag of roasted coffee beans",
        "tax_codes": [
          "TANGIBLE_PERSONAL_PROPERTY.FOOD"
        ],
        "resolved_tax_codes": [
          "TANGIBLE_PERSONAL_PROPERTY.FOOD"
        ],
        "source_updated_at": "2026-09-15T08:30:00Z",
        "created_at": "2026-09-14T20:00:00Z",
        "updated_at": "2026-09-15T08:30:05Z"
      }
    },
    {
      "index": 1,
      "status": "created",
      "product": {
        "id": "prd_01J9ZB7V3M8N2K4P6Q1R5S7T9W",
        "source_id": "SKU-124",
        "source": "shopify",
        "source_account_id": "acme-ca.myshopify.com",
        "name": "Ceramic Mug",
        "description": "12 oz stoneware mug",
        "tax_codes": [],
        "resolved_tax_codes": [
          "TANGIBLE_PERSONAL_PROPERTY"
        ],
        "source_updated_at": "2026-09-15T08:29:41Z",
        "created_at": "2026-09-15T08:30:05Z",
        "updated_at": "2026-09-15T08:30:05Z"
      }
    },
    {
      "index": 2,
      "status": "failed",
      "errors": [
        {
          "status": "409",
          "code": "conflict",
          "title": "Ambiguous source_account_id",
          "detail": "Your organization has 2 connected shopify accounts; send source_account_id to say which one the product belongs to.",
          "source": {
            "pointer": "/data/attributes/data/2/source_account_id"
          },
          "meta": {
            "source": "shopify",
            "connected_accounts": [
              "acme-ca.myshopify.com",
              "acme-us.myshopify.com"
            ]
          }
        }
      ]
    },
    {
      "index": 3,
      "status": "failed",
      "errors": [
        {
          "status": "422",
          "code": "validation_required_field",
          "title": "Missing name",
          "detail": "Please provide a value for the required name field",
          "source": {
            "pointer": "/data/attributes/data/3/name"
          }
        }
      ]
    }
  ]
}

Authorizations

APIKeyHeaderHTTPBearer

X-API-Key · string · header · required

Body

application/json

Upsert products request model.

data · CreateProductRequest · object[] · required

List of products to create or update, up to 1000 products and 5 MB per request. Each product takes the same fields as Create a product, and name is always required. For an existing product, omitted fields keep their current value; send null to clear description or source_category, and [] to clear tax_codes. source_updated_at can't be null: omit it to keep the current value. If the same product appears more than once, every copy fails.

Maximum array length: 1000

Show child attributes

Response

200

application/json

Successful Response

Upsert products response model.

summary · BatchSummary · object · required

Number of items with each result.

Show child attributes

data · BatchProductResult · object[] · required

Results in the same order as the request.

Show child attributes

object · string · default: batch

Always batch.