Skip to main content
PATCH
/
alpha
/
merchant
/
auctions
/
{slug}
Update an auction
curl --request PATCH \
  --url https://api.auctionnow.io/api/alpha/merchant/auctions/{slug} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "title": "<string>",
    "description": "<string>",
    "startingPrice": 1,
    "startTime": 123,
    "endTime": 123,
    "shippingCostUS": 1,
    "shippingCostInternational": 1,
    "urls": [
      "<string>"
    ],
    "binAble": true,
    "binAmount": 1,
    "productId": "<string>",
    "productType": "PHYSICAL",
    "digitalLink": "<string>",
    "customMessage": "<string>",
    "externalProductId": "<string>",
    "externalSubtenantId": "<string>",
    "details": {
      "color": "red",
      "size": "large"
    },
    "isArchived": true
  }
}
'
{
  "data": {
    "_id": "<string>",
    "_creationTime": 123,
    "title": "<string>",
    "description": "<string>",
    "startingPrice": 1,
    "startTime": 123,
    "endTime": 123,
    "shippingCostUS": 1,
    "shippingCostInternational": 1,
    "bidIncrement": 123,
    "partyId": "<string>",
    "slug": "<string>",
    "handle": "<string>",
    "binAble": true,
    "binAmount": 123,
    "productId": "<string>",
    "externalProductId": "<string>",
    "externalSubtenantId": "<string>",
    "details": {},
    "currentBidAmount": 123,
    "productUrl": "https://myshop.auctionnow.io/my-product-123",
    "isArchived": true
  },
  "timestamp": 123,
  "message": "<string>"
}

Headers

Authorization
string
required

Your Auction Now API key as a Bearer token

Example:

"Bearer ak_XXXXXXX"

Path Parameters

slug
string
required

The unique slug of the auction

Body

application/json
data
object
required

Fields to update on the auction

Response

Update auction success response

data
object
required

The updated auction

timestamp
number
required
message
string