/ExternalID

Esse recurso gerencia integração de informações entre plataformas, possibilitando adicionar uma informação (ID:string) do sistema local em determinados objetos para uma posterior recuperação dos dados em um pedido por exemplo.

Objetos que podem ser mapeados possuem o atributo "uid" (identificador único de 32 caracteres) e o campo "external_id".

Esse recurso poderá ser utilizado para referenciar os seguintes objetos:

• /Merchant

• /Store/Inventory/Products

• /Store/Inventory/Groups

• /Store/Sales/Categorys

• /Store/Sales/Products

• /Store/Sales/Pricings

• /Orders

Exemplo de utilização:

No sistema local possui um produto chamado "Coca-Cola Zero" que possui o código 123456 e é necessário vincula-lo com o produto no marketplace.

Passo 1: Consultar o recurso /Store/Inventory/Products pelo produto correspondente.

GET /api/merchant/store/inventory/products?filter[title]=Coca-Cola Zero HTTP/1.1
{
    "items": [
        {
            "id": "1808",
            "uid": "583cb8bf5c92707db984be9bd5a35328",
            "externalId": null,
            "merchantId": "534",
            "productGroupId": "374",
            "title": "Coca-Cola Zero",
            "titleInternalOrder": "Coca-Cola Zero",
            "image": "",
            "amount": "5.00",
            "amountDiscount": "0.00",
            "amountSale": "5.00",
            "priority": "1487",
            "active": true,
            "object": "Product"
        }
    ]
    ...
}

Foi localizado o objeto respondente que possui o identificador único "uid".

Passo 2: Atualizar/criar o ExternalID para o objeto correspondente:

PUT /api/merchant/externalid/583cb8bf5c92707db984be9bd5a35328 HTTP/1.1
{
	"content": "123456"
}

Resultado ao recuperar o objeto novamente, agora com o vínculo de "external_id":

GET /api/merchant/store/inventory/products/1808 HTTP/1.1
{
    "id": "1808",
    "uid": "583cb8bf5c92707db984be9bd5a35328",
    "externalId": "123456",
    ...
}

/EternalID

Métodos disponíveis para gerenciar esse recurso.

Listagem de ExternalIDs cadastrados

GET /v1/merchant/externalid

Método retorna todas as referências já cadastradas.

Query Parameters

Name	Type	Description
page[]	string
filter[]	string
sort[]	string

200

{
    "items": [
        {
            "id": "1",
            "uid": "4e6891d094e79f1b06231d9356703268",
            "content": "ABC123",
            "createdAt": "2018-10-02T19:20:51-0300",
            "updatedAt": "2018-10-02T19:20:51-0300",
            "object": "ExternalID"
        }
    ],
    "meta": {
        "page": {
            "total": 5,
            "currentPage": 0,
            "lastPage": 4,
            "perPage": 1
        }
    },
    "links": {
        "last": "/merchant/externalid?page%5Bsize%5D=1&page%5Bnumber%5D=4",
        "next": "/merchant/externalid?page%5Bsize%5D=1&page%5Bnumber%5D=1"
    }
}

Informações de um ExternalID

GET /v1/merchant/externalid/{uid}

Método retorna informações de um determinado ExternalID

Path Parameters

Name	Type	Description
uid	string	Identificador único de um determinado objeto (string de 32 caracteres)

200

{
    "id": "1",
    "uid": "4e6891d094e79f1b06231d9356703268",
    "content": "ABC123",
    "createdAt": "2018-10-02T19:20:51-0300",
    "updatedAt": "2018-10-02T19:20:51-0300",
    "object": "ExternalID"
}

400

{
    "errors": [
        {
            "status": 400,
            "title": "Objeto não encontrado",
            "code": "not_found"
        }
    ]
}

Atualizar ou criar um ExternalID

PUT /v1/merchant/externalid/{uid}

Método adiciona uma referência em um determinado objeto

Path Parameters

Name	Type	Description
uid	string	Identificador único de um determinado objeto

Request Body

Name	Type	Description
content	string	String de até 255 caracteres que identifica o objeto no sistema local

200

{
    "success": true
}