Formato dos Dados

Visando facilitar a compreensão das nossas APIs para o maior número de desenvolvedores parceiros, alguns retornos tiveram seus formatos normalizados. A seguir, especificamos alguns dos formatos mais relevantes dos retornos da nossa API:

Datas e horários

Nossos campos que representam datas os horários são retornados no fuso horário da loja e são representadas em UTC utilizando o padrão ISO 8601.

A informação de qual Timezone é utilizada na loja vem no próprio valor retornado.

Para os métodos em que é necessário passar uma data e horário no parâmetro, basta enviar as informações do horário local com a informação que determina o fuso horário em UTC.

Formato datetime no padrão ISO 8601

YYYY-MM-DDThh:mm:ss+hh:mm

Onde:

• YYYY representa os 4 dígitos do ano.
• MM representa os 2 dígitos do mês.
• DD representa os 2 dígitos do dia do mês.
• hh representa os 2 dígitos da hora.
• mm representa os 2 dígitos do minuto.
• ss representa os 2 dígitos do segundo.
• +hh:mm representa o timezone, que pode ser positivo ou negativo. Por exemplo: o timezone America/Sao_Paulo é representado por -03:00.

Exemplo de datetime no padrão ISO 8601

2020-01-01T09:00:00-03:00

Dias da semana

Para campos que representam dias de semana, são numeramos de 1 à 7, onde:

• O dia 1 representa o domingo, e
• o dia 7 representa o sábado.