Montagens

GET /assemblies

As montagens da loja

Escopo read_products

Os grupos de complementos dos produtos (a lente e os tratamentos da armação). Todas (no máximo 50), em ordem de nome, numa página só.

Resposta

200 Sucesso. (AssemblyList)

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 /assemblies

Cria uma montagem

Escopo write_products

Com os grupos (até 8, cada um com até 30 produtos) e as coleções e os produtos aos quais ela se aplica. Uma coleção ou um produto que já usa outra montagem é recusado (409 assembly_already_linked).

Parâmetros

Resposta

201 Sucesso. (Assembly)

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 /assemblies/{id}

Uma montagem

Escopo read_products

Com os grupos e as ligações; optional diz se o produto também vai sem a montagem, e incomplete, que algum grupo obrigatório ficou sem produto à venda.

Parâmetros

Resposta

200 Sucesso. (Assembly)

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 /assemblies/{id}

Muda campos de uma montagem

Escopo write_products

Só o que vier muda; as listas (groups, collection_ids, product_ids) trocam a anterior inteira.

Parâmetros

Resposta

200 Sucesso. (Assembly)

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 /assemblies/{id}

Exclui uma montagem

Escopo write_products

As coleções e os produtos ligados a ela ficam sem montagem; os produtos dos grupos continuam no catálogo.

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).