Visão geral

A estrutura do feed de dados de pedidos completo é definida pelo esquema de inventário relacional. O feed de dados de ordenação completo consiste nas seguintes entidades de nível superior:

O diagrama a seguir mostra como as entidades Service, Restaurant e Menu representam um único restaurante:

Diagrama de relação de classe do cardápio do restaurante
Figura 1:relação geral das entidades de feed de dados de ponta a ponta: serviço, restaurante e cardápio.

Diretrizes gerais

  • Restaurantes por arquivo: cada arquivo de dados precisa representar um restaurante com as entidades Service e Menu relacionadas. Use nomes de arquivo que possam ajudá-lo a pesquisar um arquivo para um restaurante.

  • Formato do arquivo de dados: os arquivos de dados precisam ser formatados em arquivos JSON separados por nova linha (formato ndjson).

  • Valores de DateTime e Time: para propriedades que exigem um valor DateTime ou Time, use os formatos especificados nos formatos DateTime e Time. Por exemplo, 2017-05-01T06:30:00+05:30 para DateTime e T08:08:00+05:30 para Time.

  • IDs: use uma propriedade @id para identificar todas as entidades únicas em um tipo de entidade. O tamanho máximo é de 300 caracteres. Um @id é um identificador exclusivo da entidade desse tipo. No entanto, os IDs podem se sobrepor entre as entidades. Por exemplo, suponha que você defina uma entidade Service com a propriedade @id definida como a16. Não é possível criar outra entidade Service com um @id de a16. No entanto, você pode usar a16 como o valor @id de uma entidade Menu.

  • Geração de ID: mantenha os IDs estáveis. Não use UUIDs nem os altere/aleatórios entre os uploads de feeds. Isso permite um suporte mais fácil para problemas relacionados à entidade.

  • Valores nulos: não use o valor null no lugar dos objetos. Se um objeto for opcional, omita-o do seu feed.

Bibliotecas de cliente

O gerador de códigos do cliente na seção "Ferramentas" está disponível para validar o feed de dados completo de pedidos.

Próxima
Início rápido