Update an auction item

Updates an auction item. Only the fields you send are changed; omitted fields are left as-is.

The item must not be canceled or ended. Prices are fixed amounts in the shop's currency. For items that belong to an auction event, startsAt/endsAt are dictated by the event and should be omitted from the request.

patch

Authorizations

AuthorizationstringRequired

You can retrieve your token by visiting Settings > API and clicking Generate API token.

Path parameters

idstringRequired

The auction item UID.

Example: 1c6af60by54hzdmgxy5ab4ypw0

Query parameters

fields[auction-items]stringOptional

Available values are startPrice, reservePrice, bidIncrementStrategy, automaticBidding, softClose, totalBids, highBidAmount, minimumBid, currentIncrement, startsAt, endsAt, position, status, reserveMet, canceledAt, archivedAt, processed, createdAt, updatedAt. You can include multiple values by separating them with a comma.

fields[variants]stringOptional

Available values are externalId, displayName, title, price, photoUrl, sku. You can include multiple values by separating them with a comma.

fields[products]stringOptional

Available values are externalId, title, vendor, type, photoUrl, handle. You can include multiple values by separating them with a comma.

fields[bids]stringOptional

Available values are amount, placedAt, automatic. You can include multiple values by separating them with a comma.

fields[customers]stringOptional

Available values are name, firstName, lastName, externalId, email, registeredAt, approvedAt, bannedAt, createdAt. You can include multiple values by separating them with a comma.

fields[max-bids]stringOptional

Available values are amount, createdAt. You can include multiple values by separating them with a comma.

includestringOptional

Comma-separated list of related resources to include in the response. Available values: variant, product, highBid, highBid.customer, maxBid.

Body

startsAtstring · date-timeOptional

The date and time the auction opens (ISO 8601). Must be sent together with endsAt. Ignored for items in an auction event.

endsAtstring · date-timeOptional

The date and time the auction closes (ISO 8601). Must be sent together with startsAt. Ignored for items in an auction event.

startPricenumber · min: 0.01Optional

The starting price in major currency units (e.g. 10.50). Cannot be changed once a bid has been placed.

reservePricenumber · min: 0.01 · nullableOptional

The reserve price in major currency units. Must be greater than or equal to the start price.

offerRuleIdstring · nullableOptional

The UID of an active auction offer rule to attach.

productFeeIdstring · nullableOptional

The UID of an active auction product fee to attach.

Responses

200

AuctionItemResource

application/vnd.api+json

401

Unauthenticated

application/vnd.api+json

422

Unprocessable entity

application/vnd.api+json

patch/auction-items/{id}

PATCH /v1/auction-items/{id} HTTP/1.1
Host: api.auctionplusapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 341

{
  "startsAt": "2026-01-01T00:00:00.000Z",
  "endsAt": "2026-01-01T00:00:00.000Z",
  "startPrice": 1,
  "reservePrice": null,
  "offerRuleId": null,
  "productFeeId": null,
  "bidIncrementStrategy": {
    "strategy": "fixed_amount",
    "value": {
      "amount": 1,
      "percentage": 1
    }
  },
  "automaticBidding": {
    "enabled": true
  },
  "softClose": {
    "enabled": true,
    "extendFrom": null,
    "extendDuration": null
  }
}

{
  "data": {
    "id": "cv4bpx1j2568d4pj8nhs21gjpm",
    "type": "auction-items",
    "attributes": {
      "startPrice": {
        "value": 100,
        "major": "1.00",
        "display": "$1.00",
        "currency": "USD"
      },
      "reservePrice": {
        "value": 1000,
        "major": "10.00",
        "display": "$10.00",
        "currency": "USD"
      },
      "bidIncrementStrategy": {
        "strategy": "fixed_amount",
        "value": {
          "amount": {
            "value": 500,
            "major": "5.00",
            "display": "$5.00",
            "currency": "USD"
          }
        }
      },
      "automaticBidding": {
        "enabled": true
      },
      "softClose": {
        "enabled": false,
        "extendFrom": null,
        "extendDuration": null
      },
      "totalBids": 1,
      "highBidAmount": {
        "value": 5000,
        "major": "50.00",
        "display": "$50.00",
        "currency": "USD"
      },
      "minimumBid": {
        "value": 5500,
        "major": "55.00",
        "display": "$55.00",
        "currency": "USD"
      },
      "currentIncrement": {
        "value": 500,
        "major": "5.00",
        "display": "$5.00",
        "currency": "USD"
      },
      "startsAt": "2026-07-29T18:29:55.000000Z",
      "endsAt": "2026-07-29T19:29:55.000000Z",
      "position": null,
      "status": "active",
      "reserveMet": true,
      "canceledAt": null,
      "archivedAt": null,
      "processed": false,
      "createdAt": "2026-07-29T18:29:55.000000Z",
      "updatedAt": "2026-07-29T18:29:55.000000Z"
    },
    "relationships": {
      "variant": {
        "data": {
          "type": "variants",
          "id": "text"
        }
      },
      "product": {
        "data": {
          "type": "products",
          "id": "text"
        }
      },
      "highBid": {
        "data": {
          "type": "bids",
          "id": "text"
        }
      },
      "maxBid": {
        "data": {
          "type": "max-bids",
          "id": "text"
        }
      }
    }
  },
  "included": [
    {
      "id": "text",
      "type": "text",
      "attributes": {
        "externalId": null,
        "displayName": "text",
        "title": null,
        "price": null,
        "photoUrl": null,
        "sku": null
      }
    }
  ]
}