Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve attachment docs #18

Merged
merged 2 commits into from
Sep 1, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 49 additions & 7 deletions docs/checkout/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -694,7 +694,42 @@ Você pode associar um anexo ao sku pela interface administrativa. Para verifica

Por exemplo: ao adicionar uma camiseta do Brasil ao carrinho, você pode adicionar o anexo de 'personalizacao' para que o cliente possa escolher o número a ser impresso na camiseta.

Não se esqueça de usar getOrderForm anteriormente.
Caso o attachment tenha mais de uma propriedade em seu objeto, você deverá enviar o objeto completo mesmo que só tenha mudado apenas um campo.

Exemplo:

O item possui um `attachmentOffering` da seguinte maneira:

```js
"attachmentOfferings": [{
"name": "Customização",
"required": true,
"schema": {
"Nome": {
"maximumNumberOfCharacters": 20,
"domain": []
},
"Numero": {
"maximumNumberOfCharacters": 20,
"domain": []
}
}
}],
```

O objeto `content` deve ser sempre passar todas as suas propriedades:

```js
var itemIndex = 0;
var attachmentName = 'Customização';

// Usuário inseriu o valor do campo Nome. O objeto deve também passar o campo Numero.
var content = { Nome: 'Ronaldo', Numero: '' };

vtexjs.checkout.addItemAttachment(itemIndex, attachmentName, content);
```

Não se esqueça de usar chamar o getOrderForm pelo menos uma vez anteriormente.

### Retorna

Expand All @@ -712,21 +747,28 @@ Não se esqueça de usar getOrderForm anteriormente.
### Exemplo

```js
// Chamado em algum momento antes
// vtexjs.checkout.getOrderForm()

var itemIndex = 0;
var attachmentName = 'personalizacao';
var attachmentName = 'Customização';
var content = {
"numero": "10"
Nome: 'Ronaldo',
Numero: '10'
};

vtexjs.checkout.getOrderForm().then(function(){
return vtexjs.checkout.addItemAttachment(itemIndex, attachmentName, content);
}).done(function(orderForm){
vtexjs.checkout.addItemAttachment(itemIndex, attachmentName, content).done(function(orderForm){
// Anexo incluído ao item!
console.log(orderForm);
});

```

### Possíveis Erros

**404** - O item não possui esse `attachment` associado ou o objeto `content` está com uma propriedade inválida
**400** - O objeto `content` não foi passado corretamente

Caso a chamada falhe, verifique o objeto de erro retornado (`error.message`), ele dará pistas do que está errado na chamada.

## removeItemAttachment(itemIndex, attachmentName, content, expectedOrderFormSections)

Expand Down