Update a Custom API Entry using the settings endpoint

PUT 
/v2/settings/extensions/custom-apis/:custom_api_id/entries/:custom_api_entry_id

Update a Custom API Entry using the settings endpoint

Request

Path Parameters

custom_api_id stringrequired
The id of the Custom API.
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
custom_api_entry_id uuidrequired
The id of the Custom Entry.
Example: 7e067539-6f6c-46e1-8c55-940031b36c6a

Header Parameters

If-Match string

When If-Match is set, the value must be W/"{etag_id}". If the value of the header matches, the request completes. If not, HTTP 412 Precondition Failed is returned.

application/json

Body

data CustomApiEntryAttributesrequired

type string

Specifies the type of the resource object, use the api_type of the Custom API for Custom API Entry.

Responses

200

OK

Response Headers

• ETag string

  A unique identifier representing the current version of the resource. When the resource changes, the ETag value will also change.

application/json

Schema

Schema

data CustomApiEntryAttributesrequired

id uuidrequired

The unique identifier for the Custom API Entry

type stringrequired

Specifies the type of the resource object, use the api_type of the Custom API for Custom API Entry.

links object

self uri

Specifies the URI of the Custom API Entry.

meta object

timestamps objectrequired

updated_at stringrequired

Specifies the date the entity is created.

created_at stringrequired

Specifies the date the entity is last updated.

data_size integerrequired

Default value: 0

Specifies the sum of the size of each value stored for the Custom API Entry in bytes. The total size of a Custom API Entry must not exceed 64KB.

resource_version integer

Default value: 0

A unique identifier representing the current version of the resource. When the resource changes, the resource_version value will also change.

etag_id string

A unique identifier representing the current version of the resource that is a hashed string. When the resource changes, the etag_id will also change.

Example (from schema)

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "string",
    "links": {
      "self": "/extensions/wishlists/7e067539-6f6c-46e1-8c55-940031b36c6a"
    },
    "meta": {
      "timestamps": {
        "updated_at": "2017-01-10T11:41:19.244Z",
        "created_at": "2017-01-10T11:41:19.244Z"
      },
      "data_size": 6,
      "resource_version": 4,
      "etag_id": "6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b"
    }
  }
}

valid_entry

Default Wishlist

{
  "data": {
    "id": "7e067539-6f6c-46e1-8c55-940031b36c6a",
    "type": "wishlist_ext",
    "name": "My Wishlist",
    "items_count": 0,
    "keep_purchased": false,
    "links": {
      "self": "/extensions/wishlists/7e067539-6f6c-46e1-8c55-940031b36c6a"
    },
    "meta": {
      "timestamps": {
        "updated_at": "2017-01-10T11:41:19.244Z",
        "created_at": "2017-01-10T11:41:19.244Z"
      },
      "data_size": 6,
      "resource_version": 1,
      "etag_id": "6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b"
    }
  }
}

201

Created

Response Headers

• ETag string

  A unique identifier representing the current version of the resource. When the resource changes, the ETag value will also change. The ETag hash will be the same value as etag_id, and is marked as a weak entity tag string. For example: etag: W/"5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9", etag_id: 5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9

application/json

Schema

Schema

data objectrequired
id uuidrequired
The unique identifier for the Custom API Entry
type stringrequired
Specifies the type of the resource object, use the api_type of the Custom API for Custom API Entry.
links object
self uri
Specifies the URI of the Custom API Entry.
meta object
timestamps objectrequired
updated_at stringrequired
Specifies the date the entity is created.
created_at stringrequired
Specifies the date the entity is last updated.
data_size integerrequired
Default value: 0
Specifies the sum of the size of each value stored for the Custom API Entry in bytes. The total size of a Custom API Entry must not exceed 64KB.
resource_version integer
Default value: 0
A unique identifier representing the current version of the resource. When the resource changes, the resource_version value will also change.
etag_id string
A unique identifier representing the current version of the resource that is a hashed string. When the resource changes, the etag_id will also change.
property name* any

Example (from schema)

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "string",
    "links": {
      "self": "/extensions/wishlists/7e067539-6f6c-46e1-8c55-940031b36c6a"
    },
    "meta": {
      "timestamps": {
        "updated_at": "2017-01-10T11:41:19.244Z",
        "created_at": "2017-01-10T11:41:19.244Z"
      },
      "data_size": 6,
      "resource_version": 4,
      "etag_id": "6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b"
    }
  }
}

valid_entry

Default Wishlist

{
  "data": {
    "id": "7e067539-6f6c-46e1-8c55-940031b36c6a",
    "type": "wishlist_ext",
    "name": "My Wishlist",
    "items_count": 0,
    "keep_purchased": false,
    "links": {
      "self": "/extensions/wishlists/7e067539-6f6c-46e1-8c55-940031b36c6a"
    },
    "meta": {
      "timestamps": {
        "updated_at": "2017-01-10T11:41:19.244Z",
        "created_at": "2017-01-10T11:41:19.244Z"
      },
      "resource_version": 0,
      "data_size": 6,
      "etag_id": "5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9"
    }
  }
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

missing-name

Required field missing

{
  "errors": [
    {
      "title": "Bad Request",
      "status": "400",
      "detail": "The field 'name' is required."
    }
  ]
}

404

Not found. The requested entity does not exist.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

not-found

Requested entity not found

{
  "errors": [
    {
      "title": "Not Found",
      "status": "404",
      "detail": "Not found"
    }
  ]
}

409

Unable to perform the operation at this time.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

duplicate-custom-api

Duplicate Custom API

{
  "errors": [
    {
      "title": "Conflict",
      "status": "409",
      "detail": "custom_api with the given api_type already exists"
    }
  ]
}

duplicate-custom-field

Duplicate Custom Field

{
  "errors": [
    {
      "title": "Conflict",
      "status": "409",
      "detail": "custom_field with the given slug already exists"
    }
  ]
}

412

Precondition Failed.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

pre-request-failed

Provided ETag does not match the current ETag.

{
  "errors": [
    {
      "title": "Precondition Failed",
      "status": "412",
      "detail": "The provided ETag 'W/\"4b227777d4dd1fc61c6f884f48641d02b4d121d3fd328cb08b5531fcacdabf8a\"', does not match the current ETag 'W/\"ef2d127de37b942baad06145e54b0c619a1f22327b2ebbcfbec78f5564afe39d\"'."
    }
  ]
}

413

Payload Too Large. The total size of a Custom API Entry must not exceed 64KB.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

too-large

Requested entity too large

{
  "errors": [
    {
      "title": "Request Entity Too Large",
      "status": "413",
      "detail": "Maximum entry size reached."
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

internal-server-error

Internal server error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500",
      "detail": "there was a problem processing your request"
    }
  ]
}

503

The service is temporarily unavailable. This request can be safely retried.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

service-unavailable

Service Unavailable

{
  "errors": [
    {
      "detail": "An unknown error occurred",
      "status": "503",
      "title": "Service Unavailable"
    }
  ]
}

Loading...