Entity identifiers

Resource Representation ↑

Example:
{
 "key": "loc-1",
 "identifiable_id": 2,
 "identifiable_type": "Address",
 "name": "Store Name A"
}

Supported Formats

json
>>>

GET /api/v2/entity_identifiers
List Entity identifiers

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

Response:
  {
    "page": 1,
    "per_page": 50,
    "total_pages": 1,
    "total_entries": 1,
    "entries": [
      {
        "id": 1,
        "key": "value_one",
        "identifiable_id": 1,
        "identifiable_type": "Product",
        "name": "key_one"
      }
    ]
  }

Params

Param name Description
per_page
optional

Number of objects in one response. Default is 50

Validations:

  • Must be a number.
page
optional

Page number. Default is 1

Validations:

  • Must be a number.
lang
optional

Language code for translated value

Validations:

  • Must be a String
key
optional

The key (ID) of the entity (object). Unique identifier for the entity

Validations:

  • Must be a String
name
optional

Description for the key

Validations:

  • Must be a String
identifiable_id
optional

The entity ID such as Product ID.

Validations:

  • Must be a number.
identifiable_type
optional

The entity type such as Product

Validations:

  • Must be one of: Product, Address, Category, MediaItem, InventoryLocation.
>>>

POST /api/v2/entity_identifiers
Create an additional identifier for an existing entity

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

request:
  {
    "entity_identifier": {
       "key": "m-001",
       "identifiable_id": 1095,
       "identifiable_type": "Product",
       "name": "MPN"
    }
  }

response:
  {
      "id": 3,
      "key": "m-001",
      "identifiable_id": 1095,
      "identifiable_type": "Product",
      "name": "MPN",
      "created_at": "2018-01-10T14:28:43.090+11:00",
      "updated_at": "2018-01-10T14:28:43.090+11:00"
  }

Params

Param name Description
entity_identifier
required

Validations:

  • Must be a Hash
entity_identifier[key]
required

The key (ID) of the entity (object). Unique identifier for the entity

Validations:

  • Must be a String
entity_identifier[identifiable_id]
optional , nil allowed

The entity ID such as Product ID. If this is provided, identifiable_code is not required.

Validations:

  • Must be a Integer
entity_identifier[identifiable_code]
optional , nil allowed

The entity default code such as Product code. If this is provided, identifiable_id is not required.

Validations:

  • Must be a String
entity_identifier[identifiable_type]
required

The entity type such Product

Validations:

  • Must be one of: Product, Address, Category, MediaItem, InventoryLocation.
entity_identifier[name]
optional , nil allowed

Description for the key

Validations:

  • Must be a String
>>>

PUT /api/v2/entity_identifiers/:id
Update an entity identifier

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

request:
  {
    "entity_identifier": {
       "key": "m-001",
       "identifiable_id": 1095,
       "identifiable_type": "Product",
       "name": "MPN-update"
    }
  }

response:
  {
      "id": 3,
      "key": "m-001",
      "identifiable_id": 1095,
      "identifiable_type": "Product",
      "name": "MPN-update",
      "created_at": "2018-01-10T14:28:43.090+11:00",
      "updated_at": "2018-01-10T14:28:43.090+11:00"
  }

Params

Param name Description
entity_identifier
required

Validations:

  • Must be a Hash
entity_identifier[key]
optional

The key (ID) of the entity (object). Unique identifier for the entity

Validations:

  • Must be a String
entity_identifier[identifiable_id]
optional , nil allowed

The entity ID such as Product ID. If this is provided, identifiable_code is not required.

Validations:

  • Must be a Integer
entity_identifier[identifiable_code]
optional , nil allowed

The entity default code such as Product code. If this is provided, identifiable_id is not required.

Validations:

  • Must be a String
entity_identifier[identifiable_type]
optional

The entity type such Product

Validations:

  • Must be one of: Product, Address, Category, MediaItem, InventoryLocation.
entity_identifier[name]
optional , nil allowed

Description for the key

Validations:

  • Must be a String
>>>

POST /api/v2/entity_identifiers/reset
Reset the additional identifiers with the same name for an existing entity

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

request:
  {
    "entity_identifier": {
       "key": "m-001",
       "identifiable_id": 1095,
       "identifiable_type": "Product",
       "name": "MPN"
    }
  }

response:
  {
      "id": 3,
      "key": "m-001",
      "identifiable_id": 1095,
      "identifiable_type": "Product",
      "name": "MPN",
      "created_at": "2018-01-10T14:28:43.090+11:00",
      "updated_at": "2018-01-10T14:28:43.090+11:00"
  }

Params

Param name Description
entity_identifier
required

Validations:

  • Must be a Hash
entity_identifier[key]
required

The key (ID) of the entity (object). Unique identifier for the entity

Validations:

  • Must be a String
entity_identifier[identifiable_id]
optional , nil allowed

The entity ID such as Product ID. If this is provided, identifiable_code is not required.

Validations:

  • Must be a Integer
entity_identifier[identifiable_code]
optional , nil allowed

The entity default code such as Product code. If this is provided, identifiable_id is not required.

Validations:

  • Must be a String
entity_identifier[identifiable_type]
required

The entity type such Product

Validations:

  • Must be one of: Product, Address, Category, MediaItem, InventoryLocation.
entity_identifier[name]
optional , nil allowed

Description for the key

Validations:

  • Must be a String
>>>

DELETE /api/v2/entity_identifiers/:id
Delete an entity identifier

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

response:
  {
    "id": 2
  }