Coleções e marcas

GET /collections

As coleções da loja

Escopo read_products ou read_content

As categorias da loja, em árvore, numa lista plana na ordem do menu: cada coleção seguida das de baixo dela. Todas (no máximo 2.000) cabem numa página só.

Resposta

200 Sucesso. (CollectionList)

Erros

• 401 O token falta, não existe, foi revogado ou venceu (authentication_error).
• 403 O token não tem o escopo da rota, ou, com write_content, mandou campos que pedem write_products, listados em fields (permission_error).
• 429 Chamadas demais: espere o Retry-After (rate_limited).
• 500 Erro do nosso lado (api_error).
• 503 A API está ocupada com outras chamadas: espere o Retry-After (api_error).

POST /collections

Cria uma coleção

Escopo write_products

No fim das coleções do mesmo lugar da árvore (até 3 níveis). Sem handle, o endereço sai do título.

Parâmetros

Resposta

201 Sucesso. (CollectionWithContent)

Erros

• 400 A chamada veio com campos inválidos; os campos recusados vão em fields (invalid_request).
• 401 O token falta, não existe, foi revogado ou venceu (authentication_error).
• 403 O token não tem o escopo da rota, ou, com write_content, mandou campos que pedem write_products, listados em fields (permission_error).
• 409 O estado do recurso não permite a mudança, ou ele mudou desde a leitura (conflict).
• 429 Chamadas demais: espere o Retry-After (rate_limited).
• 500 Erro do nosso lado (api_error).
• 503 A API está ocupada com outras chamadas: espere o Retry-After (api_error).

GET /collections/{id}

Uma coleção

Escopo read_products ou read_content

Com o texto da página e o título e a descrição para os buscadores.

Parâmetros

Resposta

200 Sucesso. (CollectionWithContent)

Erros

• 401 O token falta, não existe, foi revogado ou venceu (authentication_error).
• 403 O token não tem o escopo da rota, ou, com write_content, mandou campos que pedem write_products, listados em fields (permission_error).
• 404 O recurso não existe nesta loja (not_found).
• 429 Chamadas demais: espere o Retry-After (rate_limited).
• 500 Erro do nosso lado (api_error).
• 503 A API está ocupada com outras chamadas: espere o Retry-After (api_error).

PATCH /collections/{id}

Muda campos de uma coleção

Escopo write_products ou write_content

Só o que vier muda. Um parent_id novo move a coleção, com as de baixo, para o fim do lugar novo; o endereço antigo leva ao novo. Com write_content, só os textos: title, description, seo e handle; qualquer outro campo dá 403 missing_scope, com os campos que pedem write_products em fields.

Parâmetros

Resposta

200 Sucesso. (CollectionWithContent)

Erros

• 400 A chamada veio com campos inválidos; os campos recusados vão em fields (invalid_request).
• 401 O token falta, não existe, foi revogado ou venceu (authentication_error).
• 403 O token não tem o escopo da rota, ou, com write_content, mandou campos que pedem write_products, listados em fields (permission_error).
• 404 O recurso não existe nesta loja (not_found).
• 409 O estado do recurso não permite a mudança, ou ele mudou desde a leitura (conflict).
• 422 O pedido é válido, mas não pode ser atendido como está (invalid_request).
• 429 Chamadas demais: espere o Retry-After (rate_limited).
• 500 Erro do nosso lado (api_error).
• 503 A API está ocupada com outras chamadas: espere o Retry-After (api_error).

DELETE /collections/{id}

Exclui uma coleção

Escopo write_products

Os produtos saem dela e continuam nas outras. A coleção com outras debaixo dela não sai (409).

Parâmetros

Resposta

204 Sucesso, sem corpo.

Erros

• 401 O token falta, não existe, foi revogado ou venceu (authentication_error).
• 403 O token não tem o escopo da rota, ou, com write_content, mandou campos que pedem write_products, listados em fields (permission_error).
• 404 O recurso não existe nesta loja (not_found).
• 409 O estado do recurso não permite a mudança, ou ele mudou desde a leitura (conflict).
• 429 Chamadas demais: espere o Retry-After (rate_limited).
• 500 Erro do nosso lado (api_error).
• 503 A API está ocupada com outras chamadas: espere o Retry-After (api_error).

GET /brands

As marcas da loja

Escopo read_products ou read_content

Todas (no máximo 2.000), em ordem de nome, numa página só.

Resposta

200 Sucesso. (BrandList)

Erros

• 401 O token falta, não existe, foi revogado ou venceu (authentication_error).
• 403 O token não tem o escopo da rota, ou, com write_content, mandou campos que pedem write_products, listados em fields (permission_error).
• 429 Chamadas demais: espere o Retry-After (rate_limited).
• 500 Erro do nosso lado (api_error).
• 503 A API está ocupada com outras chamadas: espere o Retry-After (api_error).

POST /brands

Cria uma marca

Escopo write_products

Sem handle, o endereço sai do nome. O logo se envia pelo painel.

Parâmetros

Resposta

201 Sucesso. (Brand)

Erros

• 400 A chamada veio com campos inválidos; os campos recusados vão em fields (invalid_request).
• 401 O token falta, não existe, foi revogado ou venceu (authentication_error).
• 403 O token não tem o escopo da rota, ou, com write_content, mandou campos que pedem write_products, listados em fields (permission_error).
• 409 O estado do recurso não permite a mudança, ou ele mudou desde a leitura (conflict).
• 429 Chamadas demais: espere o Retry-After (rate_limited).
• 500 Erro do nosso lado (api_error).
• 503 A API está ocupada com outras chamadas: espere o Retry-After (api_error).

GET /brands/{id}

Uma marca

Escopo read_products ou read_content

A marca, com quantos produtos são dela.

Parâmetros

Resposta

200 Sucesso. (Brand)

Erros

• 401 O token falta, não existe, foi revogado ou venceu (authentication_error).
• 403 O token não tem o escopo da rota, ou, com write_content, mandou campos que pedem write_products, listados em fields (permission_error).
• 404 O recurso não existe nesta loja (not_found).
• 429 Chamadas demais: espere o Retry-After (rate_limited).
• 500 Erro do nosso lado (api_error).
• 503 A API está ocupada com outras chamadas: espere o Retry-After (api_error).

PATCH /brands/{id}

Muda campos de uma marca

Escopo write_products ou write_content

Só o que vier muda; o logo fica. Um handle novo leva o endereço antigo ao novo. Todos os campos da marca são texto: write_content basta.

Parâmetros

Resposta

200 Sucesso. (Brand)

Erros

• 400 A chamada veio com campos inválidos; os campos recusados vão em fields (invalid_request).
• 401 O token falta, não existe, foi revogado ou venceu (authentication_error).
• 403 O token não tem o escopo da rota, ou, com write_content, mandou campos que pedem write_products, listados em fields (permission_error).
• 404 O recurso não existe nesta loja (not_found).
• 409 O estado do recurso não permite a mudança, ou ele mudou desde a leitura (conflict).
• 429 Chamadas demais: espere o Retry-After (rate_limited).
• 500 Erro do nosso lado (api_error).
• 503 A API está ocupada com outras chamadas: espere o Retry-After (api_error).

DELETE /brands/{id}

Exclui uma marca

Escopo write_products

Os produtos dela ficam sem marca.

Parâmetros

Resposta

204 Sucesso, sem corpo.

Erros

• 401 O token falta, não existe, foi revogado ou venceu (authentication_error).
• 403 O token não tem o escopo da rota, ou, com write_content, mandou campos que pedem write_products, listados em fields (permission_error).
• 404 O recurso não existe nesta loja (not_found).
• 429 Chamadas demais: espere o Retry-After (rate_limited).
• 500 Erro do nosso lado (api_error).
• 503 A API está ocupada com outras chamadas: espere o Retry-After (api_error).